From ec023df146280cb4315f23cd4940094eb638d61b Mon Sep 17 00:00:00 2001 From: Mountain Man Date: Sat, 8 Apr 2023 15:38:36 -0400 Subject: Create `CONTRIBUTING.md` `CONTRIBUTING.md` is a standard file to have in any open-source repository. This file instructs new contributors on how to contribute to the project, as well as the Code of Conduct. --- CONTRIBUTING.md | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 57 insertions(+) create mode 100644 CONTRIBUTING.md (limited to 'CONTRIBUTING.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..d450c7d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,57 @@ +# Contributing to MMOSMacs + +Howdy, and welcome to the MMOSMacs git repository. This document +outlines the conventions and standards for the project. + + +## This is personal + +Please understand that this is my personal Emacs configuration. MMOSMacs +is designed to meet my personal needs. I welcome any and all +contributions, and I will do my best to make MMOSMacs accessible to +others, but my needs and preferences ultimately take priority. + +All contributors are listed at the end of this document. If you have +contributed and your name does not appear here, submit a PR or RFC Issue +for it to be added. + + +## Code of Conduct + +I will reject all contributions from: +- people who abuse other contributors. +- people I know to be affiliated with any state agency. + +Furthermore, individual items will be rejected because of: +- exceptionally vulgar language. +- ignorance or disregard of the `STYLE_GUIDE.md` or Issue/PR templates. + + +## How to Contribute + +There are several ways you can contribute. + +The easiest way you can contribute is by taking part in the discussions +on the [GitHub Issues page](https://github.com/MountainMan1312/MMOSMacs/Issues). +You can comment on topics that already have an existing Issue, or you +can submit your own if it does not already exist. Issues can take the +form of: +- **Feedback**: share your thoughts about MMOSMacs. +- **Bug Report**: discusion about a problem with the MMOSMacs code. +- **RFC**: discussion about making a change to MMOSMacs. + +Before submitting a new issue, search for existing duplicate issues. If +it already exists, comment on the existing Issue instead of making a new +one. Duplicate issues will be removed and you will be asked to move your +post to the comment section of the existing post. It's not to be rude, +it's just for organization's sake. + +Each type of Issue has an Issue Template. The templates can be found in +the `.github/ISSUE_TEMPLATE/` directory. Pull reqeusts also have +templates which are located in `.github/PULL_REQUEST_TEMPLATE/`. + +To contribute code: +1. Make an RFC or find an existing one +2. Discuss your proposed changes +3. Make your changes +4. Submit a Pull Request -- cgit v1.2.3