Author: dr
Date: Tue Jun 12 09:55:33 2007
New Revision: 5383
Log:
- Updated dev process according to discussions from the conference meetings.
Modified:
docs/dev_process.txt
Modified: docs/dev_process.txt
==============================================================================
--- docs/dev_process.txt [iso-8859-1] (original)
+++ docs/dev_process.txt [iso-8859-1] Tue Jun 12 09:55:33 2007
@@ -112,6 +112,10 @@
3. _`Design specifications`
~~~~~~~~~~~~~~~~~~~~~~~~~~~
+At this point we assign a mentor to the component. This mentor
+makes sure all the necessary steps and reviews are done correctly and keeps an
+eye on the design, working closely with the developer that makes the design.
+
The design specification describes how the feature is going to be implemented
with the requirements document in mind. The design specification is there to
see whether something can be implemented, and also explores the different
@@ -164,6 +168,7 @@
In the implementation step the feature is implemented according to the design
specifications. When this step is reached for a new feature, the appropriate
directory structures can be moved from "`experimental`_" to "`trunk`_".
+
There are several sub-items in this step:
5.1. _`Write API stubs with parameter documentation and descriptions`
@@ -199,16 +204,21 @@
.. _`set-up the test environment`:
http://svn.ez.no/svn/ezcomponents/docs/test_environment.txt
-5.3. Implement classes
-``````````````````````
+5.3. Initial Implementation
+```````````````````````````
There are many guidelines for implementing classes and methods. Please refer to
the `guidelines`_.
.. _`guidelines`:
http://svn.ez.no/svn/ezcomponents/docs/guidelines/implementation.txt
-5.4. _`Implementation Review`
-`````````````````````````````
+Transition
+##########
+
+After the first implementation has been done, alpha1 is released.
+
+5.4. _`Initial Implementation Review`
+`````````````````````````````````````
After the implementation of the classes there is a review required of the
implementation. The review should be done by at least two people that where
@@ -219,11 +229,31 @@
.. _`review`: http://svn.ez.no/svn/ezcomponents/docs/guidelines/review.txt
+5.5. Updating Implementation according to review
+````````````````````````````````````````````````
+
+After the `Initial Implementation Review`_ has been done, the original
+developer updates the implementation according to provided feedback. In case
+conflicting opinions exist the issues need to be discussed on the list, in all
+other cases it is suggested to discuss those on the list as well.
+
+Transition
+##########
+
+Release a beta version of the component.
+
+5.6. Implementation Review
+``````````````````````````
+
+The updated code is reviewed once again according to the `review`_ guidelines.
+If more issues arise go back to step 5.5.
+
Transition
``````````
Once the implementation has been reviewed and all the comments of the reviewers
-have been integrated into the implementation the next step can be started.
+have been integrated into the implementation a Release Candidate can be
+released.
6. _`Testing`
@@ -286,9 +316,9 @@
From the `The Seven Steps`_, step 2 (`Write Requirements Document`_) and step 3
(Write `Design Specifications`_) can be omitted because a bug is in violation
with either one of those documents. Step 5.1 (`Write API stubs with parameter
-documentation and descriptions`_) and step 5.4 (`Implementation Review`_) are
-also not required, although the latter might be a good idea to do for very
-large fixes.
+documentation and descriptions`_) and step 5.4/5.6 (`Initial Implementation
+Review`_) are also not required, although the latter might be a good idea
+to do for very large fixes.
.. _CLA: http://ez.no/ezpublish/contributing/cla
@@ -327,6 +357,29 @@
done on a backward compatibility breaking change.
+Version States
+==============
+
+pre-alpha
+ Development state, everything can change.
+
+alpha 1
+ First release of a component up for initial review.
+
+beta 1
+ First release of a component after the implementation of review comments.
+ The API is still subject to change, but the general workings of the
+ component should not change anymore.
+
+beta n
+ Releases of a component after implementation of more reviews. The API is
+ still allowed to change, but doing so is discouraged.
+
+rc 1
+ Release candidate, the API can not change anymore unless there is an
+ extremely compelling reason to do so.
+
+
Glossary
========
--
svn-components mailing list
svn-components@lists.ez.no
http://lists.ez.no/mailman/listinfo/svn-components
