| [663] | 1 | .. _contribute_code: |
|---|
| 2 | |
|---|
| [659] | 3 | Contribute code |
|---|
| 4 | =============== |
|---|
| 5 | |
|---|
| [663] | 6 | Anybody is welcome to share source code and to report bugs or feature requests using the following instructions. |
|---|
| [659] | 7 | |
|---|
| 8 | Submit new code |
|---|
| 9 | -------------------------- |
|---|
| 10 | |
|---|
| [663] | 11 | For new comers |
|---|
| 12 | ************************* |
|---|
| [659] | 13 | |
|---|
| [663] | 14 | New source code or existing source code corrections (patches) should be submitted using the ZOO-Project bug tracking system (ZOO-Trac). |
|---|
| 15 | |
|---|
| 16 | Create a new ticket in order to describe your code or patch and attach it to the ticket (attach all the needed files needed to use your code or patch). It will then be checked and discussed with the developers, and can potentially be merged with the trunk. |
|---|
| 17 | |
|---|
| 18 | For registered developers |
|---|
| 19 | *************************** |
|---|
| 20 | |
|---|
| 21 | ZOO-Project registered developers have direct svn access and can: |
|---|
| 22 | |
|---|
| 23 | * Commit fixes, enhancement and new source directly to trunk |
|---|
| 24 | |
|---|
| 25 | * Create and commit to a new branch of the svn |
|---|
| 26 | |
|---|
| [668] | 27 | ZOO-Project registered developers must accept and respect the :ref:developer guidelines when contributing code. |
|---|
| [665] | 28 | |
|---|
| [663] | 29 | Bug tracking |
|---|
| [659] | 30 | -------------------------- |
|---|
| 31 | |
|---|
| [663] | 32 | General information |
|---|
| 33 | ********************* |
|---|
| [659] | 34 | |
|---|
| [663] | 35 | Bug reports and wishes can be submitted using the ZOO-Trac. This requires you to setup a user account (userid) using this section. |
|---|
| 36 | |
|---|
| 37 | The following trackers are available: |
|---|
| 38 | |
|---|
| 39 | * *defects* to report bugs and 'bad' features |
|---|
| 40 | * *enhancement* to describe feature wishes |
|---|
| 41 | * *task* to describe any different but relevant topic. |
|---|
| 42 | |
|---|
| 43 | The following components are available: |
|---|
| 44 | |
|---|
| 45 | * *Developemnt platform* to report bugs and 'bad' features |
|---|
| 46 | * *ZOO-Kernel* to report a bug or problem with the ZOO-Project WPS server |
|---|
| 47 | * *ZOO-Services* to report a bug or problem with the ZOO-Project WPS services |
|---|
| 48 | * *ZOO-API* to report a bug or problem with the ZOO-Project API |
|---|
| 49 | * *ZOO-Client* to report a bug or problem with the ZOO-Project Client |
|---|
| 50 | * *Documentation* to report a problem or suggest an enhancement to the documentation |
|---|
| 51 | |
|---|
| 52 | Best practices |
|---|
| 53 | ********************* |
|---|
| 54 | |
|---|
| 55 | Please consider the following when submitting bugs or feature requests: |
|---|
| 56 | |
|---|
| 57 | * Check if the bug is still persistent in svn trunk before reporting. If you use an older version, please consider upgrading. |
|---|
| 58 | * Before reporting a bug, please search if it is yet unknown in the bug tracking system. |
|---|
| 59 | * Give an appropriate, starightforward and understandable title to your ticket using the *Summary* field |
|---|
| 60 | * Make sure the developers get all the needed information to recreate the bug using the *Description* field (e.g. tell about your configuration and explain every step to reproduce the bug). |
|---|
| 61 | * Select at least a *Type* of tracker and a *Component* for your new ticket. |
|---|
| 62 | * Report only one single bug by ticket. |
|---|
| 63 | |
|---|
| 64 | |
|---|
