|
| 1 | +# How to contribute |
| 2 | + |
| 3 | +Thank you so much for wanting to contribute to Ermis! To contribute: |
| 4 | + |
| 5 | +1. **Fork the repository.** |
| 6 | +2. **Open a new issue** — if you are intending to fix a bug or feature — describing it thoroughly. |
| 7 | +3. **Create a new branch** for your feature or bug fix. |
| 8 | +4. **Ensure your code is clean and readable** — at least to some extent. |
| 9 | + It doesn't have to be perfect, but aim for clarity, and avoid ambiguity and complexity as much as possible. |
| 10 | + |
| 11 | + Remember: |
| 12 | + > _"An idiot admires complexity, while a genius appreciates simplicity"_ |
| 13 | + > — **Terry A. Davis** |
| 14 | + > |
| 15 | + > _"Truth is ever to be found in simplicity, and not in the multiplicity and confusion of things"_ |
| 16 | + > — **Sir Isaac Newton** |
| 17 | + |
| 18 | + Lastly, try adhering to the most rudimental and basic [programming principles]. |
| 19 | + |
| 20 | +> **Note:** if you are wondering what this project's style guide is — it doesn't have one. Nevertheless, if you are looking for a reference of how files should be formatted: |
| 21 | +> |
| 22 | +> - For code formatting, I have found that [Google's Style guide] is thorough, comprehensive — and broadly applicable. |
| 23 | +> - In terms of documentation, I would suggest [Microsoft's Writing Style Guide]. |
| 24 | +> |
| 25 | +> That said, don't sweat too much about following these strictly — I myself probably don't conform to most of their conventions. |
| 26 | +
|
| 27 | +5. **Submit a pull request** with a detailed description of your changes — and I may review it eventually. |
| 28 | + |
| 29 | +[Microsoft's Writing Style Guide]: https://learn.microsoft.com/en-us/style-guide/welcome |
| 30 | +[Google's Style guide]: https://google.github.io/styleguide |
| 31 | +[programming principles]: https://github.com/webpro/programming-principles |
| 32 | + |
| 33 | +## Pull requests |
| 34 | + |
| 35 | +Unless the change is something very trivial, such as correcting a typo, it's |
| 36 | +generally best to begin by opening a new issue outlining the bug or feature you |
| 37 | +intend to address. Even if you think it's relatively insignificant, it's helpful |
| 38 | +to know what people are working on. |
| 39 | + |
| 40 | +Some examples of types of pull requests that are immediately helpful: |
| 41 | + |
| 42 | + - Fixing a typo. |
| 43 | + - Improving documentation. |
| 44 | + - Removing redundant configurations. |
| 45 | + |
| 46 | +Guidelines for any code contributions: |
| 47 | + |
| 48 | + 1. All contributions must be licensed under AGPL 3.0 (As dictated by the license) and all files must have a |
| 49 | + copy of the boilerplate license comment; i.e `LICENSE.txt`. |
| 50 | + 2. Please squash all commits for a change into a single commit (this can be done using `git rebase -i`). |
| 51 | + Do your best to have a [well-formed commit message] for the change. |
| 52 | + |
| 53 | +[well-formed commit message]: https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html |
0 commit comments