openproject/CONTRIBUTING.md

OpenProject is an open source project and we encourage you to help us out. For contributing to OpenProject, please read the following guidelines.

Please also note that these rules should be acknowledged by everyone, but repository contributors might occasionally deviate from them for practical purposes, e.g. not fork the repo, but have a branch on the main repository. This should however stay an exception.

Contributors License Agreement

External contributors have to sign a CLA before contributing to OpenProject. The CLA can be found here and has to be filled out and sent to cla@openproject.org. Additionally, a GPG signature has to be provided.

Development flow

For contributing source code, please follow the git workflow below:

• Fork OpenProject on GitHub
• Clone your fork to your development machine:

git clone git@github.com/<username>/openproject

• Optional: Add the original OpenProject repository as a remote, so you can fetch changes:

git remote add upstream git@github.com:opf/openproject

• Make sure you're on the right branch. The main development branch is dev:

git checkout dev

• Create a feature branch:

git checkout -b feature/<short description of your feature>

• Make your changes, then push the branch into your own repository:

git push origin <your feature branch>

• Create a pull request against a branch of of the <opf/openproject> repository, containing a clear description of what the pull request attempts to change and/or fix.

If your pull request does not contain a description for what it does and what it's intentions are, we will reject it. If you are working on a specific work package from the list, you may include a link to that work package in the description, so we can track your work.

We will then review your pull request. Please note that you can add commits after the pull request has been created by pushing to the branch in your fork.

Important notes

To ensure a smooth workflow for everyone, please take note of the following:

Testing

Please add tests to your code to verify functionality, especially if it is a new feature.

Pull requests will be verified by TravisCI as well, but please run them locally as well and make sure there are green before creating your pull request. We have a lot of pull requests coming in and it takes some time to run the complete suite for each one.

Branching model

The main development branch for upcoming releases is dev. For identifying the branch to create a pull request against, please refer to these rules:

• If in doubt, create your pull request against dev. All new features, gem updates and bugfixes for the upcoming release should go into the dev branch.
• Hotfixes should be created against the appropiate release/* branch. Backports for fixes also go against their specific release/* branch.

If you push to your branch in quick sucession, please consider stopping the associated Travis builds, as Travis will run for each commit. This is especially true if you force push to the branch.

Please also use [ci skip] in your commit message to suppress builds which are not necessary (e.g. after fixing a typo in the README).

Inactive pull requests

We want to keep the Pull request list as cleaned up as possible - we will aim close pull requests after an inactivity period of 72 hours (no comments, no further pushes) which are not labelled as work in progress by us.

Issue tracking and coordination

We use OpenProject for development coordination - please have a look at the work packages list for upcoming features and reported bugs.

Etiquette and communication

Lastly, be nice and respectful to each other. We are working hard to make OpenProject the best project management software there is and we are grateful for each contribution.

If you want to get in touch with us, there is also a Gitter channel to talk to us directly.