Contribution Workflow

This documents aims to describe the contribution workflow the shanoir-ng code repository.

Pull requests

A contributor may submit a pull request, based on the branch [develop]. This pull request may be accepted if the following requirements are met :

1 - The code quality meets up our requirement. 2 - When applicable, the code should provides it’s own integration/system/unit tests. 3 - In addition to that, the pull request must be accompanied with a clear description of how to test it manually. 4 - The pull request is properly tagged with the copyright regime you intend the code to be integrated with. We are susceptible to accept the following : 4.1 - The contribution is minor, I certify I have developed it or have the right to contribute the code, and all associated rights are assigned to Inria. 4.2 - The contribution is significant and I will send the proper paperwork to assign copyright to Inria. 4.3 - You are asking that this code be integrated even if you or your employer is keeping all the rights to the contribution and is licensing it under the GPL license. If you intend to work on the code base and request integration of your work under this regime, please ask before working so that we can agree that this is acceptable for the foreseen contribution.

Commiters

When accepted, the submitted code becomes part of the "develop" branch, meaning it will included in the next release.

Acceptation is performed by one of the project’s committers. The current commiters are :

• Michael Kain
• Yao Yao
• Julien Louis You can reach them at [email protected] Regular contributors are invited to ask to become committers if they wish. Any request is approved by the Shanoir Consortium’s Executive Committee.

Rules beetween the commiters

1 - Code quality requirements

This section is under construction.

2 - Automatic tests

This section is under construction.

3 - Manual tests

This section is under construction.