Add 'CONTRIBUTING.md'

This commit is contained in:
swiftmandolin 2020-09-08 04:30:42 +00:00
parent bb142829bf
commit 360c746809
1 changed files with 13 additions and 0 deletions

13
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,13 @@
# How to contribute to this style guide
The most important aspect for contributing to this is to discuss what should be added and even more importantly, why. Most of the work in this repo will be issues labeled `discussion`. Once one topic has been agreed upon, we can move on to changes and pull requests. So if you think something should be added, please submit a discussion issue where we can all talk about it.
To submit changes, please open a pull request (after forking) and submit your changes.
I only have a few rules for formatting which I'll explain below:
- Use `##` for each section
- Use `###` for the subsection headers
- Provide a rule
- Provide the reasoning for the rule under "Why?" subsection
- Provide an example (or multiple examples for edge cases)