Commit Policy

This page describes commit policy that is used in pyclustering repository.

1. All changes must be done on development branches x.x.x.dev.
2. If feature is implemented, tested, documented and build status is green, then it can be merge to master branch.
3. Release branch must be always created from stable master branch.
4. Each commit should have reference to issue and following the format:

#<ISSUE_NUMBER>: <Changes description>.

Here is an example to changes that were introduced in scope of the issue #490:

$ git commit . -m "#490: Silhouette C++ implementation."

There are special commit prefixes that can be used to notify CI about particular changes:

Commit Prefix	Purpose	Comment
[no-build]	Do not trigger build and testing process	Option can be used when code base is not touched, for example, in case of update README.md
[build-only-osx]	Build and test MAC OS library version	Option can be used when code base related to MAC OS only was changed.