We want to make contributing to LearningOrchestra as easy and as simple as humanly possible.
Whether you want to:
- Report an issue
- Contribute with a feature
- Contribute with a fix
Before you open an issue or a pull request, check whether that issue has been discussed already or a PR exists that addresses it. Don't open pull requests for issues that are already under review.
After looking through the issues and seeing that an issue is available for you to tackle, you may begin the pull request process.
When creating an issue for a bug or other undefined/unwanted behaviour remember to include in your issue or pull request steps necessary to reproduce that behaviour.
- Fork the repository
- Clone your fork to your local environment
- Navigate into the project root directory
- Create a new branch, the branch should be named according to what feature/fix you're implementing
- Make your changes, stage them and commit them to the branch
- Make sure to use proper language idioms, formatting and linting before commiting your work, like proper variable naming, indentation, etc.
- Make sure your code passes any tests the repository offers
- Make sure to adopt the coding style of the repository and not to force your own coding habits into the codebase
- Push the changes to your fork
- Create a Pull Request
Remember to describe what feature or fix you're implementing in the Pull Request window. In the Pull Request window remember to include a quick summary of what the committed code does and how it is an improvement.
After the Pull Request has been submitted, the repository owner will review your request.
Be patient, if they require you to make changes to your request, do so.
Please be polite to other members and contributors and follow GitHub etiquette.
Don't be rude, use crude language or harass other users.
The repository is currently licenses under GNU General Public License v3.0. By contributing to the project you agree that your contributions will be licensed under the same license and provisions.