|
| 1 | +# Contributing to LearningOrchestra |
| 2 | +We want to make contributing to LearningOrchestra as easy and as simple as humanly possible.\ |
| 3 | +Whether you want to: |
| 4 | +* Report an issue |
| 5 | +* Contribute with a feature |
| 6 | +* Contribute with a fix |
| 7 | + |
| 8 | +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. |
| 9 | + |
| 10 | +After looking through the issues and seeing that an issue is available for you to tackle, you may begin the pull request process. |
| 11 | + |
| 12 | +### Reporting a bug/issue |
| 13 | +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. |
| 14 | + |
| 15 | +## Pull Request process |
| 16 | + |
| 17 | +1. [Fork](https://github.com/riibeirogabriel/learningOrchestra/fork) the repository |
| 18 | +2. [Clone](https://git-scm.com/docs/git-clone) your fork to your local environment |
| 19 | +3. Navigate into the project root directory |
| 20 | +4. Create a new [branch](https://git-scm.com/book/en/v2/Git-Branching-Basic-Branching-and-Merging), the branch should be named according to what feature/fix you're implementing |
| 21 | +5. Make your changes, stage them and [commit](https://git-scm.com/docs/git-commit) them to the branch |
| 22 | + - Make sure to use proper language idioms, formatting and linting before commiting your work, like proper variable naming, indentation, etc. |
| 23 | + - Make sure your code passes any tests the repository offers |
| 24 | + - Make sure to adopt the coding style of the repository and not to force your own coding habits into the codebase |
| 25 | +6. [Push](https://git-scm.com/docs/git-push) the changes to your fork |
| 26 | +7. Create a Pull Request |
| 27 | + |
| 28 | +Remember to describe what feature or fix you're implementing in the Pull Request window. |
| 29 | +In the Pull Request window remember to include a quick summary of what the committed code does and how it is an improvement. |
| 30 | + |
| 31 | +After the Pull Request the repository owner will review your request.\ |
| 32 | +Be patient, if they require you to make changes to your request, do so. |
| 33 | + |
| 34 | +## Standards |
| 35 | +Please be polite to other members and contributors and follow GitHub etiquette.\ |
| 36 | +Don't be rude, use crude language or harass other users. |
| 37 | + |
| 38 | +## License |
| 39 | +The repository is currently licenses under GNU General Public License v3.0. |
| 40 | +By contributing to the project you agree that your contributions will be licensed under the same license and provisions. |
0 commit comments