diff options
| -rw-r--r-- | CONTRIBUTING.md | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..d450c7d --- /dev/null +++ b/CONTRIBUTING.md | |||
| @@ -0,0 +1,57 @@ | |||
| 1 | # Contributing to MMOSMacs | ||
| 2 | |||
| 3 | Howdy, and welcome to the MMOSMacs git repository. This document | ||
| 4 | outlines the conventions and standards for the project. | ||
| 5 | |||
| 6 | |||
| 7 | ## This is personal | ||
| 8 | |||
| 9 | Please understand that this is my personal Emacs configuration. MMOSMacs | ||
| 10 | is designed to meet my personal needs. I welcome any and all | ||
| 11 | contributions, and I will do my best to make MMOSMacs accessible to | ||
| 12 | others, but my needs and preferences ultimately take priority. | ||
| 13 | |||
| 14 | All contributors are listed at the end of this document. If you have | ||
| 15 | contributed and your name does not appear here, submit a PR or RFC Issue | ||
| 16 | for it to be added. | ||
| 17 | |||
| 18 | |||
| 19 | ## Code of Conduct | ||
| 20 | |||
| 21 | I will reject all contributions from: | ||
| 22 | - people who abuse other contributors. | ||
| 23 | - people I know to be affiliated with any state agency. | ||
| 24 | |||
| 25 | Furthermore, individual items will be rejected because of: | ||
| 26 | - exceptionally vulgar language. | ||
| 27 | - ignorance or disregard of the `STYLE_GUIDE.md` or Issue/PR templates. | ||
| 28 | |||
| 29 | |||
| 30 | ## How to Contribute | ||
| 31 | |||
| 32 | There are several ways you can contribute. | ||
| 33 | |||
| 34 | The easiest way you can contribute is by taking part in the discussions | ||
| 35 | on the [GitHub Issues page](https://github.com/MountainMan1312/MMOSMacs/Issues). | ||
| 36 | You can comment on topics that already have an existing Issue, or you | ||
| 37 | can submit your own if it does not already exist. Issues can take the | ||
| 38 | form of: | ||
| 39 | - **Feedback**: share your thoughts about MMOSMacs. | ||
| 40 | - **Bug Report**: discusion about a problem with the MMOSMacs code. | ||
| 41 | - **RFC**: discussion about making a change to MMOSMacs. | ||
| 42 | |||
| 43 | Before submitting a new issue, search for existing duplicate issues. If | ||
| 44 | it already exists, comment on the existing Issue instead of making a new | ||
| 45 | one. Duplicate issues will be removed and you will be asked to move your | ||
| 46 | post to the comment section of the existing post. It's not to be rude, | ||
| 47 | it's just for organization's sake. | ||
| 48 | |||
| 49 | Each type of Issue has an Issue Template. The templates can be found in | ||
| 50 | the `.github/ISSUE_TEMPLATE/` directory. Pull reqeusts also have | ||
| 51 | templates which are located in `.github/PULL_REQUEST_TEMPLATE/`. | ||
| 52 | |||
| 53 | To contribute code: | ||
| 54 | 1. Make an RFC or find an existing one | ||
| 55 | 2. Discuss your proposed changes | ||
| 56 | 3. Make your changes | ||
| 57 | 4. Submit a Pull Request | ||