aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorMountain Man <43313373+MountainMan1312@users.noreply.github.com>2023-04-08 20:07:22 -0400
committerGitHub <noreply@github.com>2023-04-08 20:07:22 -0400
commite274a5f8cbc3cdf6d953e8b37a6c8d79f62266a9 (patch)
tree4fabc673a7ad3d50104bdb959fd8f8869ba4622c /CONTRIBUTING.md
parentInitial commit (diff)
parentCreate `STYLE_GUIDE.md` (diff)
downloadmmosmacs-e274a5f8cbc3cdf6d953e8b37a6c8d79f62266a9.tar.gz
mmosmacs-e274a5f8cbc3cdf6d953e8b37a6c8d79f62266a9.tar.bz2
mmosmacs-e274a5f8cbc3cdf6d953e8b37a6c8d79f62266a9.zip
Merge `initial-plans-docs` branch to `stable` branch
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md57
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
3Howdy, and welcome to the MMOSMacs git repository. This document
4outlines the conventions and standards for the project.
5
6
7## This is personal
8
9Please understand that this is my personal Emacs configuration. MMOSMacs
10is designed to meet my personal needs. I welcome any and all
11contributions, and I will do my best to make MMOSMacs accessible to
12others, but my needs and preferences ultimately take priority.
13
14All contributors are listed at the end of this document. If you have
15contributed and your name does not appear here, submit a PR or RFC Issue
16for it to be added.
17
18
19## Code of Conduct
20
21I will reject all contributions from:
22- people who abuse other contributors.
23- people I know to be affiliated with any state agency.
24
25Furthermore, 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
32There are several ways you can contribute.
33
34The easiest way you can contribute is by taking part in the discussions
35on the [GitHub Issues page](https://github.com/MountainMan1312/MMOSMacs/Issues).
36You can comment on topics that already have an existing Issue, or you
37can submit your own if it does not already exist. Issues can take the
38form 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
43Before submitting a new issue, search for existing duplicate issues. If
44it already exists, comment on the existing Issue instead of making a new
45one. Duplicate issues will be removed and you will be asked to move your
46post to the comment section of the existing post. It's not to be rude,
47it's just for organization's sake.
48
49Each type of Issue has an Issue Template. The templates can be found in
50the `.github/ISSUE_TEMPLATE/` directory. Pull reqeusts also have
51templates which are located in `.github/PULL_REQUEST_TEMPLATE/`.
52
53To contribute code:
541. Make an RFC or find an existing one
552. Discuss your proposed changes
563. Make your changes
574. Submit a Pull Request