P4DTI issue job000070

TitleNo coding practice documentation
Assigned userRichard Brooksby
DescriptionThere's no documentation for coding practices, especially on version branches, which could make merging very hard, especially when other people are extending the system.
AnalysisNeed stronger conventions about development coding practice, especially in version branches. Don't delete stuff. Add comments explaining why a change was made (especially in version branches). Sign comments. Refer to reports of defects when fixing them. Check in each defect fix separately. What to put in change comments, and so on. The goal being to make it possible to decide about merging into the masters later, and for different people to maintain the code along the version branch successfully.
Documentation needs to go in the Integrator's Guide as well, so that they know how to make changes that might possibly be merged back into the main distribution.
How foundmanual_test
Evidence<http://www.ravenbrook.com/project/p4dti/doc/2000-10-24/teamshare-psg-alpha-test/> item 19
Created byRichard Brooksby
Created on2000-11-22 15:13:51
Last modified byGareth Rees
Last modified on2001-12-10 19:03:11
History2000-11-22 RB Created from sources (see evidence).


Change Effect Date User Description
12704 closed 2001-05-19 16:48:50 Gareth Rees Documented practices for making changes on branches so that they can be merged.