Skip to content

Latest commit

 

History

History
86 lines (67 loc) · 4.1 KB

CONTRIBUTING.md

File metadata and controls

86 lines (67 loc) · 4.1 KB
Raw

Guidelines for Contributing to Sardana

The Sardana repository uses nvie's branching model, known as GitFlow.

In this model, there are two long-lived branches:

  • master: used for official releases. Contributors should not need to use it or care about it
  • develop: reflects the latest integrated changes for the next release. This is the one that should be used as the base for developing new features or fixing bugs.

For the contributions, we use the Fork & Pull Model:

  1. the contributor first forks the official sardana repository
  2. the contributor commits changes to a branch based on the develop branch and pushes it to the forked repository.
  3. the contributor creates a Pull Request against the develop branch of the official sardana repository.
  4. anybody interested may review and comment on the Pull Request, and suggest changes to it (even doing Pull Requests against the Pull Request branch). At this point more changes can be committed on the requestor's branch until the result is satisfactory.
  5. once the proposed code is considered ready by an appointed sardana integrator, the integrator merges the pull request into develop.

Important considerations:

In general, the contributions to sardana should consider following:

  • The code must comply with the Sardana coding conventions. Sardana travis-ci will check it for each Pull Request (PR) using the latest version of flake8 available on PyPI. The check will be done just on this part of code that is modified by the PR together with some lines of context. In case the check fails, please correct the errors and commit to the PR branch again. You may consider running the check locally using the flake8_diff.sh script in order to avoid unnecessary commits. If you find problems with fixing these errors do not hesitate to ask for help in the PR conversation! We will not reject any contribution due to these errors - the purpose of this check is just to maintain the code base clean.

  • The contributor must be clearly identified. The commit author email should be valid and usable for contacting him/her.

  • Commit messages should follow the commit message guidelines. Contributions may be rejected if their commit messages are poor.

  • The licensing terms for the contributed code must be compatible with (and preferably the same as) the license chosen for the Sardana project (at the time of writing this file, it is the LGPL, version 3 or later).

Notes:

  • These contribution guidelines are very similar but not identical to those for the GithubFlow workflow. Basically, most of what the GitHubFlow recommends can be applied for Sardana except that the role of the master branch in GithubFlow is done by develop in our case.

  • If the contributor wants to explicitly bring the attention of some specific person to the review process, mentions can be used

  • If a pull request (or a specific commit) fixes an open issue, the pull request (or commit) message may contain a Fixes #N tag (N being the number of the issue) which will automatically close the related Issue