Contributing Guidelines

How to become a contributor and submit your own code

Contributing code#

If you have improvements to this project, send us your pull requests! For those just getting started, Github has a how to.

I-Stem team members will be assigned to review your pull requests. Once the pull requests are approved and pass continuous integration checks, a I-Stem team member will apply ready to pull label to your change. This means we are working on getting your pull request submitted to our internal repository. After the change has been submitted internally, your pull request will be merged automatically on GitHub.

If you want to contribute, start working through the project codebase, navigate to the Github "issues" tab and start looking through interesting issues with "Contribution Help".

These are issues that we believe are particularly well suited for outside contributions, often because we probably won't get to them right now. If you decide to start on an issue, leave a comment so that other people know that you're working on it. If you want to help out, but not alone, use the issue comment thread to coordinate.

Pull Request Checklist#

Before sending your pull requests, make sure you followed this list.

  • Document any change in behaviour. Make sure the README.md and any other relevant documentation are kept up-to-date.
  • Consider our release cycle. We try to follow SemVer v2.0.0. Randomly breaking public APIs is not an option.
  • Create feature branches. Don't ask us to pull from your master branch.
  • One pull request per feature. If you want to do more than one thing, send multiple pull requests.
  • Send coherent history. Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.