Skip to content

Latest commit

 

History

History
35 lines (23 loc) · 1.66 KB

CONTRIBUTING.md

File metadata and controls

35 lines (23 loc) · 1.66 KB
Raw

Contributing

Last revised: August 9th, 2021
Templates revised: August 9th, 2021

General rules

  1. English only for issues & pull requests.
  2. Do not edit README.md! This file is automatically generated.
  3. Personal opinions will not be considered when adding or removing an alternative. Instead, provide links to articles with details.
  4. Use the templates when submitting an Issue or Pull Request. Blank Issues/PRs are not allowed.

How to submit a change

A: I am not familiar with GitHub or Pull Requests

  1. Open a new Issue.
  2. Select a template to use. If in doubt, use Other.
  3. Fill out the information to the best of your ability.
  4. When you are finished, click Submit new issue.

B: I have used GitHub Pull Requests

  1. Create your Pull Request with your changes.
    • Remember to not edit README.md!
    • As with Issues, fill out the template as best you can.
  2. For PR's relating to alternatives, please follow the steps above to also create an Issue for discussion. Simple PR's that are unrelated to a specific alternative may not require an Issue. If in doubt, create an Other Issue.

I contributed but I am not in the list (or) I do not want to be in the list anymore

If you submitted a change that made it into the guide but don't have your Reddit or GitHub username in the CONTRIBUTORS.md list, open an issue or pull request so I can fix it. Alternatively, if your username is on the list and you do not want it there, feel free to request this as well.