|
| 1 | +# Contributing to the MXCHandbook |
| 2 | + |
| 3 | +👍🎉 First off, thanks for taking the time to contribute! 🎉👍 |
| 4 | + |
| 5 | +The following is a set of guidelines for contributing to the handbook. These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request. |
| 6 | + |
| 7 | +## Issues |
| 8 | +Issues are created [here](https://github.com/DutchDevOfficial/MXC_Handbook/issues). |
| 9 | + |
| 10 | +For any issue, there are fundamentally three ways an individual can contribute: |
| 11 | + |
| 12 | +- By opening the issue for discussion: If you believe that you have found a new bug, you should report it by creating a new issue in the DutchDevOfficial/MXC_Handbook issue tracker. |
| 13 | +- By helping to triage the issue: You can do this either by providing assistive details (a reproducible test case that demonstrates a bug) or by providing suggestions to address the issue. |
| 14 | +- By helping to resolve the issue: This can be done by demonstrating that the issue is not a bug or is fixed; but more often, by opening a pull request that changes the source in DutchDevOfficial/MXC_Handbook in a concrete and reviewable manner. |
| 15 | + |
| 16 | +## Languages |
| 17 | +We accept issues in any language. When an issue is posted in a language besides English, it is acceptable and encouraged to post an English-translated copy as a reply. Anyone may post the translated reply. In most cases, a quick pass through translation software is sufficient. Having the original text as well as the translation can help mitigate translation errors. |
| 18 | + |
| 19 | +Responses to posted issues may or may not be in the original language. |
| 20 | + |
| 21 | +**Please note** that using non-English as an attempt to circumvent our Code of Conduct will be an immediate, and possibly indefinite, ban from the project. |
| 22 | + |
| 23 | +## Pull Requests |
| 24 | +Pull Requests are the way concrete changes are made to the code, documentation, |
| 25 | +dependencies, and tools contained in the `DutchDevOfficial/MXC_Handbook` repository. |
| 26 | + |
| 27 | +* [Setting up your local environment]() |
| 28 | + * [Step 1: Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) |
| 29 | + * [Step 2: Build](https://github.com/DutchDevOfficial/MXC_Handbook/wiki#quick-start) |
| 30 | + * [Step 3: Branch](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/managing-branches) |
| 31 | +* Making Changes |
| 32 | + * Step 4: Code |
| 33 | + * [Step 5: Commit](https://github.com/git-guides/git-commit) |
| 34 | + * [Commit message guidelines]() - coming soon |
| 35 | + * [Step 6: Rebase](https://docs.github.com/en/get-started/using-git/about-git-rebase) |
| 36 | + * Step 7: Test |
| 37 | + * [Step 8: Push](https://docs.github.com/en/get-started/using-git/pushing-commits-to-a-remote-repository) |
| 38 | + * [Step 9: Opening the Pull Request](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) |
| 39 | + * Step 10: Discuss and Update |
| 40 | + * Step 11: Waiting for approval |
| 41 | + * Continuous Deployment |
| 42 | + |
| 43 | +## Style Guides |
| 44 | +coming soon |
0 commit comments