Development Process

Welcome to the FreeBMD Development process page.

This page describes the complete life cycle of how changes and enhancements move from being ideas to implementation. People requesting changes, and proof-readers who are checking the changes, need only know how to use PTS in the manner described on this page. To use PTS you do not need to install any software, but you will need to be given an account and a password to use it. This will be created by Dave (or Graham or Ben) when you join the development team.

Developers who will implement the changes use PTS too, and also need to use CVS and SSH. These are needed to access the files to be edited, and to return them to be tested prior to deployment on the live system. The same approach is taken to changes to the code, to web pages or to data (e.g. district map files). A zipped file containing the correct versions of CVS and SSH to run on Windows for use on the project can be downloaded here (cvs_ssh.zip), and there is also a page of instructions on how to install and run them.

Sources of Ideas

• Discussions on FreeBMD-Discuss
• Discussions on FreeBMD-Scratchpad
• Ideas mailed in

Recording the request [Requester]

The tool used for recording changes is PTS

1. Create a new task
2. Assign to user "TODO"
3. Set the project according to the project table
4. Set the priority according to the priority table
5. Without using any double quotes or snippets of broken HTML, enter a one line description of the change, being as descriptive as possible.
6. Enter a fuller description of the changes in the box below
7. Click on POST to add the task

Allocating requests [Developer]

• The priorities allocated to the various tasks
• Their areas of expertise and level of proficiency

Making Changes [Developer]

1. In PTS change the task status to "In Progress"
2. Ensure that your local copy of the repository is up to date by typing cvs update
3. Edit the relevant files in your local repository
4. Check HTML files in both IE and NS (if possible) before upload
5. Check your changes into cvs using cvs ci
6. Update the development server by accessing this URL http://test.links.org:8080/devt-cgi/update
7. Test HTML and CGI changes on the test site at http://test.links.org:8080/
8. To test non-cgi program changes (rootsweb-FreeBMD2/bin), you will either need to ask Ben, Dave or Graham to run the programs, or you will need to create your own test environment on the Development machine. (ask for advice)
9. Once you are happy with your testing, change the task status in PTS to "Ready for Test" and assign it to the person who originally requested it.

Testing Changes [Requester]

1. You will receive e-mail notification that the task has been assigned back to you
2. Unless advised otherwise, you will be able to test your change at http://test.links.org:8080/
3. If you are happy that the change is what you requested, you should set the task status to "Tested OK" and assign the task back to the developer who sent it to you.
4. If you are not happy, you should describe what is wrong in the followup box, set the status to "In Progress" and assign it back to the developer.
5. If you are happy, but you would like a second opinion on the readability of a page, set the status to "Proof Read Rqd" and assign to a proof reader.

Proof Reading [Proof Reader]

1. You will receive e-mail notification that the task has been assigned back to you
2. Unless advised otherwise, you will be able to test the change at http://test.links.org:8080/
3. If you are happy with the change , you should set the task status to "Tested OK" and assign the task back to the developer (check the followup history to find the developer).
4. If you are not happy, you should describe what is wrong in the followup box, set the status to "In Progress" and assign it back to the developer.

Requesting Transfer to Production [Developer]

1. You will receive an e-mail notification when the task is assigned back to you as "Tested OK"
2. Tag each changed module by typing cvs tag T1234 rootsweb-FreeBMD2/html/development.html
   • Replace T1234 with the TID from PTS preceeded by T
   • Replace rootsweb-FreeBMD2/html/development.html with the name of each changed module.
3. Add a followup to the task in PTS, listing which modules have been changed, list any restrictions about when the module must go live (e.g. "To go live after next DB update) and assign it to Dave Mayall, in status "Ready to Deploy"

Transfer to production [Dave]

1. For each change that is due to go live, shift the current live version tag by typing cvs tag -F -r T1234 BMD_LIVE
   • Replace T1234 with the TID from PTS preceeded by T
2. Assign a Rollback tag by typing cvs tag -F -r BMD_LIVE BMD_LIVE_YYMMDD
   • Replace YYMMDD with the Current date (in YYMMDD format)
3. Bring the Production server up to the current "BMD_LIVE" level by typing cvs update -r BMD_LIVE rootsweb-FreeBMD2
4. Close the task in PTS. In the closing comments note the implementation date

FreeBMD Main Page