Skip to content

Latest commit

 

History

History
25 lines (21 loc) · 1.29 KB

CONTRIBUTING.md

File metadata and controls

25 lines (21 loc) · 1.29 KB

Contributors Guidelines

Contributions to py3minepi are welcome! Please adhere to the following contribution guidelines though:

  • Please follow the coding guidelines.
  • Use meaningful commit messages: First line of your commit message should be a very short summary (ideally 50 characters or less). After the first line of the commit message, add a blank line and then a more detailed explanation (when relevant). This is a nice blog post concerning git commit messages.
  • Add yourself to the AUTHORS.txt file.
  • Even if you have write access to the repository, never push commits directly to master. Always create a branch or a fork and post a pull request. The pull request will then be merged by someone other than you after at least 1 approving comment by a py3minepi organization member.

If you want to make sure that your changes didn't break anything, you may also run the test suite before committing and pushing your changes. (If you don't, the changes will still be automatically tested though on Travis CI.)

Thanks for your contribution!