The team is more than happy to accept contributions from anyone! This article covers how to contribute effectively and defines what the team expects from all contributors.
If you’ve never made an open-source contribution before, here’s how:
Prerequisites
- Install
git. If you’re on MacOS or Linux,gitis already installed. If on Windows, it’s a great idea to follow all of our instructions using Git Bash, as that terminal supports Linux commands. - If needed, install a
githelper, such as GitHub Desktop. - Create a GitHub account.
Forks & Pull Requests
- Browse our repositories on GitHub.
- Fork any repositories you wish to contribute to.
- Clone the forked repository using these instructions.
- Once cloned, create a new feature branch (e.g.
feature/my-cool-change). Make your code changes, then commit and push those changes to your fork. - Open a pull request. This will allow the team to review your code before merging any changes. Once your code is merged, celebrate! You just made o!TR better for everyone.
Claiming an Issue
If there is an issue on our board with no assignee, feel free to pick it up by leaving a comment on the issue stating your intention to work on it. Please provide updates on your progress by commenting on the issue, especially if you decide to stop working on it.
Pull Requests
When creating a pull request, please ensure the following (where applicable):
- The changes made have been double-checked and thoroughly tested.
- Altered code is inspected for quality issues, bugs, and possible performance issues.
- The pull request title and description are clear.