IRISpy is an open project that enourages everyone to contribute in any way possible. This document descibes how to contribute code and documentation to the IRISpy repository.
- Get a GitHub Account
- Fork the IRISpy repo to your own github account.
- Clone your forked version of IRISpy from your github account to your local machine.
- Make your changes locally and push them to your fork.
- Create a Pull Request.
When you submit a pull request it can be reviewed and commented on by anyone. For the code to be accepted into IRISpy it must meet the following criteria:
- Conform to code quality standards, primarily PEP8.
- Have close to 100% unit test coverage.
- Have API documentation generated by astropy's automodapi extenstion where appropriate.
- Contain an entry in the CHANGELOG.md file.
- Be approved by at least two IRISpy contributors.
From time to time, large feature development work may occur in branches other than master, and all
maintained releases currently have a branch i.e. 0.6.
When making a PR to one of these branches, please put the name of the branch in square brackets at
the beginning of the PR, i.e. [0.6] My bug fix. This makes it easier to filter and review these PRs.
For more information on contributing to SunPy check out the following:
- The SunPy Developers Guide.
- The Pull Request Review wiki page.
- The SunPy IRC channel #SunPy on irc.freenode.net