| 1 | .. _contribute_code: |
|---|
| 2 | |
|---|
| 3 | Contribute code |
|---|
| 4 | =============== |
|---|
| 5 | |
|---|
| 6 | Anybody can take part to the `ZOO-Project <http://zoo-project.org>`__ developement and is welcome to: |
|---|
| 7 | |
|---|
| 8 | * Share new source code or correction |
|---|
| 9 | |
|---|
| 10 | * Create tickets to report bugs |
|---|
| 11 | |
|---|
| 12 | * Write a new feature request. |
|---|
| 13 | |
|---|
| 14 | Submit new code |
|---|
| 15 | --------------- |
|---|
| 16 | |
|---|
| 17 | For new comers |
|---|
| 18 | ************** |
|---|
| 19 | |
|---|
| 20 | New source code or existing source code corrections (patches) should |
|---|
| 21 | be submitted using the ZOO-Project bug tracking system (`ZOO-Trac |
|---|
| 22 | <http://zoo-project.org/trac>`__ ). |
|---|
| 23 | |
|---|
| 24 | Create a `new ticket <http://zoo-project.org/trac/newticket>`__ in |
|---|
| 25 | order to describe your code or patch and attach it to the ticket |
|---|
| 26 | (attach all the files required to use your code or patch). It will |
|---|
| 27 | then be checked and discussed with the developers, and can potentially |
|---|
| 28 | be integrated and merged with the trunk. |
|---|
| 29 | |
|---|
| 30 | For registered developers |
|---|
| 31 | *************************** |
|---|
| 32 | |
|---|
| 33 | ZOO-Project registered developers have direct svn access and can: |
|---|
| 34 | |
|---|
| 35 | * Commit fixes, enhancement and new source directly to trunk |
|---|
| 36 | |
|---|
| 37 | * Create and commit to a new branch of the svn |
|---|
| 38 | |
|---|
| 39 | ZOO-Project registered developers must accept and respect the :ref:`contribute_dev` when contributing code. |
|---|
| 40 | |
|---|
| 41 | Bug tracking |
|---|
| 42 | -------------------------- |
|---|
| 43 | |
|---|
| 44 | General information |
|---|
| 45 | ********************* |
|---|
| 46 | |
|---|
| 47 | Bug reports and wishes can be submitted using the `ZOO-Trac <http://zoo-project.org/trac>`__ . This requires you to setup a user account (userid) using this section. |
|---|
| 48 | |
|---|
| 49 | The following trackers are available: |
|---|
| 50 | |
|---|
| 51 | * *defects* to report bugs and 'bad' features |
|---|
| 52 | * *enhancement* to describe feature wishes |
|---|
| 53 | * *task* to describe any different but relevant topic. |
|---|
| 54 | |
|---|
| 55 | The following components are available: |
|---|
| 56 | |
|---|
| 57 | * *Developemnt platform* to report bugs and 'bad' features |
|---|
| 58 | * *ZOO-Kernel* to report a bug or problem with the ZOO-Project WPS server |
|---|
| 59 | * *ZOO-Services* to report a bug or problem with the ZOO-Project WPS services |
|---|
| 60 | * *ZOO-API* to report a bug or problem with the ZOO-Project API |
|---|
| 61 | * *ZOO-Client* to report a bug or problem with the ZOO-Project Client |
|---|
| 62 | * *Documentation* to report a problem or suggest an enhancement to the documentation |
|---|
| 63 | |
|---|
| 64 | Best practices |
|---|
| 65 | ********************* |
|---|
| 66 | |
|---|
| 67 | Please consider the following when submitting bugs or feature requests: |
|---|
| 68 | |
|---|
| 69 | * Check if the bug is still persistent in svn trunk before reporting. If you use an older version, please consider upgrading. |
|---|
| 70 | * Before reporting a bug, please search if it is yet unknown in the bug tracking system. |
|---|
| 71 | * Give an appropriate, starightforward and understandable title to your ticket using the *Summary* field |
|---|
| 72 | * 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). |
|---|
| 73 | * Select at least a *Type* of tracker and a *Component* for your new ticket. |
|---|
| 74 | * Report only one single bug by ticket. |
|---|
| 75 | |
|---|
| 76 | |
|---|
