Context Navigation

Changes between Version 5 and Version 6 of Guidelines/MaintenanceGuidelines

Timestamp:: Nov 23, 2008, 3:39:51 PM (14 years ago)
Author:: viboes
Comment:: --

Legend:

: Unmodified
: Added
: Removed
: Modified

Guidelines/MaintenanceGuidelines

-              v5
+              v6
 [[PageOutline]]
+'''MAINTENACE GUIDELINES'''
 WARNING: The contents of this page is not the result of a consensus on the Boost community.
 …
-== Include a diff file respect to the previous release [author, RM] == #diff_file
-This file is the explicit report of all the changes in the library. It could be used by the Boost community to inspect that every change has been correctly documented (see inspections bellow).
 == Trac ticket and test cases association [author] == #ticket_test_case_map
 …
 == Inter dependency table [author] == #dependency
+== Dependency to other Boost library [author] == #dependency
 …
 Once the deprecated period is expired the author should remove them.
 = Test and Inspections =
 == Regression Test and track system traceability == #ticket_test_case
+= Test =
+== Regression Test and track system traceability == #ticket_test_case [user]
 A bug ticket should be associated to one or several test cases, either the test cases exists already and we are in face of a regression for some toolset, or a new toolset is considered, or a new test case is needed to reproduce the bug and the modification solve the problem.
+ * State clearly which test cases reproduce the bug it they exists [user]
+ * Propose a new test case reproducing the bug otherwise [user]
+== Preserve the test from the preceding versions [author] == #old_tests
+State clearly which test cases reproduce the bug it they exists and propose a new test case reproducing the bug otherwise [user]
+== Preserve the test from the preceding versions [author] == #released_tests
 The test from the preceding versions should not be changed when the author modifies its library. These not changed tests are a probe of compatibility with the preceding version. When these test must be changed they indicate a breaking user code issue. So instead of changing them add new ones stating explicitly on which version they were included. Old tests that should fail can be moved to the compile_fail or run_fail tests on the Jamfile.
+= Release Management =
+== Announce new features on a library [author] == #announce
+== Set read-only right on the released test files [author] == #read_only_released_tests
+In order to avoid erroneous modification of the the released tests files the author could change the rights of the test files. If the author has no permission to do that  as a the last resort he could change the permission in its own SVN copy.
+= Inspections  =
+== Announce new library features [author] == #announce
 It would be great if the author announce to the Boost mailing lists the new features just before committing in the release branch. This will let the time to the Boost community to inspect the modifications introduced.
+== Inspect announced modifications [author, user, RM] == #review
+The use of the diff file will help to inspect that the modifications introduced have been correctly included on the documentation and a good test coverage has been done. This will result in a non official mini-review of the library.
+== Inspect the code [author, user, RM] == #review
+Inspect the code to check that the new modifications do not include user code breaks. Tools comparing the contents of the current release and the preceding one could be help.
+== Check that every modification has been documented [author, user, RM] == #coherent_doc
+Inspect that every modification has been reported on the documentation. Tools comparing the contents of the current release and the preceding one could be help.
+== Check that every modification has been tested [author, user, RM] == #test_coverage
+Inspect that every modification has been tested. Tools comparing the contents of the current release and the preceding one could be help.
 …
 ||Documentation||[wiki:Guidelines/MaintenanceGuidelines#feature_request Feature Request for each deprecated/suppressed/modified/new feature]||
 ||Documentation||[wiki:Guidelines/MaintenanceGuidelines#release_note Release note and track system traceability]||
-||Documentation||[wiki:Guidelines/MaintenanceGuidelines#diff_file Include a diff file respect to the previous release ]||
 ||Documentation||[wiki:Guidelines/MaintenanceGuidelines#ticket_test_case_map Trac ticket and test cases association]||
 ||Code||[wiki:Guidelines/MaintenanceGuidelines#dont_using Do not use using sentences in test programs]||
 ||Code||[wiki:Guidelines/MaintenanceGuidelines#dont_delete_files Do not delete files prematurely ]||
+||Code||[wiki:Guidelines/MaintenanceGuidelines#dont_delete_cpp_symbols Do not delete classes/functions/variables prematurely]||
 ||Code||[wiki:Guidelines/MaintenanceGuidelines#deprecated_removal Remove the deprecated features on a given release]||
-||Code||[wiki:Guidelines/MaintenanceGuidelines#dont_delete_cpp_symbols Do not delete classes/functions/variables prematurely]||
 ||Code||[wiki:Guidelines/MaintenanceGuidelines#dont_modify_prototypes Do not modify functions prototypes prematurely]||
 ||Test||[wiki:Guidelines/MaintenanceGuidelines#ticket_test_case Regression Test and track system traceability]||
+||Test||[wiki:Guidelines/MaintenanceGuidelines#old_tests Preserve the test from the preceding versions]||
+||Release Management||[wiki:Guidelines/MaintenanceGuidelines#announceAnnounce new features on a library]||
+||Release Management||[wiki:Guidelines/MaintenanceGuidelines#review Inspect announced modifications]||
+||Test||[wiki:Guidelines/MaintenanceGuidelines#released_tests Preserve the test from the preceding versions]||
+||Inspections||[wiki:Guidelines/MaintenanceGuidelines#announce Announce new library features]||
+||Inspections||[wiki:Guidelines/MaintenanceGuidelines#review Inspect the code].||
+||Inspections||[wiki:Guidelines/MaintenanceGuidelines#coherent_doc Check that every modification has been documented]||
+||Inspections||[wiki:Guidelines/MaintenanceGuidelines#test_coverage Check that every modification has been tested]||
 = User guidelines =
 …
 ||Code||[wiki:Guidelines/MaintenanceGuidelines#dont_using Do not use using sentences]||
 ||Test||[wiki:Guidelines/MaintenanceGuidelines#ticket_test_case Regression Test and track system traceability]||
+||Release Management||[wiki:Guidelines/MaintenanceGuidelines#review Inspect announced modifications].||
+||Inspections||[wiki:Guidelines/MaintenanceGuidelines#review Inspect the code].||
+||Inspections||[wiki:Guidelines/MaintenanceGuidelines#coherent_doc Check that every modification has been documented]||
+||Inspections||[wiki:Guidelines/MaintenanceGuidelines#test_coverage Check that every modification has been tested]||
 = Release manager guidelines =
+||Documentation||[wiki:Guidelines/MaintenanceGuidelines#author Announce new features on a library]||
+||Release Management||[wiki:Guidelines/MaintenanceGuidelines#review Inspect announced modifications].||
+||Inspections||[wiki:Guidelines/MaintenanceGuidelines#review Inspect the code]||
+||Inspections||[wiki:Guidelines/MaintenanceGuidelines#coherent_doc Check that every modification has been documented]||
+||Inspections||[wiki:Guidelines/MaintenanceGuidelines#test_coverage Check that every modification has been tested]||