Blocks development occurs in two separate branches: The master branch is the
development branch. If you want to contribute a new feature or change the
behavior of Blocks in any way, please make your pull request to this branch.
The stable branch contains the latest release of Blocks. If you are fixing a
bug (that is present in the latest release), make a pull request to this branch.
If the bug is present in both the master and stable branch, two separate
pull requests are in order.
Great! We're always happy to help people contribute to Blocks. Here are few steps to help you get started:
- GitHub crash course
- If you're new to GitHub, be sure to check out our quick reference to the pull-request workflow, which will show you how to fork Blocks, create a new branch, and make a pull-request of your changes.
- Writing documentation
- If you're writing docstrings, please make sure that they comply with the NumPy docstring standard. All of our documentation is written in reStructuredText.
- Formatting guidelines
- We're pretty strict about following PEP 8 guidelines. See the documentation for some tips on how to make sure your code is fully compliant.
- Code guidelines
- If you're going to write a lot of code, have a read through our coding guidelines.
- License
- Blocks is licensed under the MIT license, with portions licensed under the 3-clause BSD license. By contributing you agree to license your contributions under the MIT license.
Please send your questions to the Blocks users mailing list. You might not be the first one with this question or problem, so be sure to search both the mailing list and the GitHub issues to make sure the answer isn't out there already.