Commits Guidelines

Before to send your pull request you have to follow the following general rules.

1. Generally you are not going to do a single big commit with all your changes while you are working in your code. Normally you are going to have safe points commits, merges/rebases and other information that is useful for your development process but doesn't add any useful information to the project if you send your pull request with all those commits on it. First you have to squash the commits into a single commit with a really good commit message. The general rule to follow is that every commit should be able to be used as an isolated cherry pick.

2. Your message has to be descriptive and useful. First line should be a descriptive sentence about what the commit is doing. It has to be clear and fully understandable what the full commit is going to do just reading that single line.

3. You have to include the issue number prefixed with # at the end of the first line

4. The next line should be a blank line followed by an enumerated list with the commit details

5. Add the right keyworkds for the commit as described in Closing issues via commit messages in the GitHub documentation.

Finally you have to get a commit message like this one:

Adds <feature description> to anaconda. Resolves #1936 and #Fixes #1941

    * Addition 1
    * Fix 1
    * Change 1
    * Deprecates 1
    * Deprecates 2
    ...

For detailed information refer to the Git Workflow guidelines that anaconda project follow since version 1.3.5