125975 - Process Documentation

Status: RESOLVED FIXED

(Bugzilla :: bugzilla.org, defect)

Description

[Matthew Tuck [:CodeMachine]]

We need someone to document our processes.  This will help people help us and
take over where necessary.

Development/Review Process
--------------------------

All new development should adhere to the Hackers' Guide.
How the reviewing process works.
How do I become a reviewer?
How to check in

Release Notes
-------------

Update dependencies, important outstanding issues, introduction, deprecated
features.
Add new section for changes from last version.  Check through Bonsai and
Bugzilla for interesting changes to add.
Keep style of existing document, esp. with regard to bug numbers, sections and
indentation.
Remember to scan change sections from previous versions of the release notes. 
They make need to be updated for users jumping over versions.

Documentation
-------------

Compiling the documentation.
Using macros.

Releasing
---------

Use the existing list on the release tracking bug.
Mention creating release tracking and notes bug (if its not on the list just
mentioned).


Any more thoughts on these documents, or more documents?

Comment 1

[Matthew Tuck [:CodeMachine]]

Moving process information bug to the web site component and taking them.

Comment 2

[Matthew Tuck [:CodeMachine]]

Development/review is in.

Comment 3

[Matthew Tuck [:CodeMachine]]

There are now reviewers', developers' and release noters' guides.

We still need release process and documentation.

Comment 4

[Dave Miller [:justdave]]

Most of the stuff that's listed here is done.  The little bit that isn't is also
covered on bug 204313, so I'll resolve this and leave that one open to cover the
rest.