From 8be93df774cc4d205f9f1cfa49f76fec712edbcc Mon Sep 17 00:00:00 2001 From: tycrek Date: Tue, 29 Sep 2020 10:17:58 -0600 Subject: [PATCH] New CONTRIBUTING.md guidelines --- CONTRIBUTING.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d58e5de..fdda8cc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,20 +1,20 @@ # Contributing -### General +###### Last revised: September 29th, 2020 -1. **[Open an Issue](https://github.com/tycrek/degoogle/issues/new/choose) before opening a Pull Request**. We can use Issue's for discussion on adding/removing/modifying alternatives. -2. **English only** for Issues & Pull Requests. -3. As of May 25 2020, the `README.md` file is automatically generated. Please edit anything in `yaml/` or `md/`. -4. If you submitted a change that made it into the guide but don't have your Reddit or GitHub username in the [CONTRIBUTORS.md](https://github.com/tycrek/degoogle/blob/master/CONTRIBUTORS.md) list, open an Issue or Pull Request so we can fix it, or update your existing Issue with the request. Alternatively, if your username is on the list and you do *not* want it there, feel free to request this as well. +## General -### New alternatives +1. **English only** for issues & pull requests. +2. As of May 25 2020, the `README.md` file is **automatically generated**. Instead, edit anything in `yaml/` or `md/`. +3. Limit yourself to **one** alternative per Issue. A pull request can have multiple alternatives as long as there is an Issue for each. +4. Personal opinions will **not** be considered when adding or removing an alternative. Instead, provide links to articles with details. +5. If you submitted a change that made it into the guide but don't have your Reddit or GitHub username in the [CONTRIBUTORS.md](https://github.com/tycrek/degoogle/blob/master/CONTRIBUTORS.md) list, open an issue or pull request so we can fix it, or update your existing issue with the request. Alternatively, if your username is on the list and you do *not* want it there, feel free to request this as well. -1. **Use the Issue template.** -2. **Fill out as much info as you can**. This makes it easier for maintainers to quickly approve changes. -2. Limit yourself to **one** alternative per Issue. -7. Check to see if the alternative you want added already exists in the guide. +## Issue & pull request templates -### Removing alternatives +1. Using the templates is **required**. Blank issues or pull requests are not allowed. Circumventing this by removing the text from a template will result in your Issue being closed without question. +2. Not every field is required but fill out as much info as you can. This makes it easier for maintainers to quickly approve changes. -1. **No personal opinions** on why a service should be removed. Links to articles with details is much more helpful. -2. Limit yourself to **one** alternative per Issue. +## Pull requests + +1. All pull requests **must** have an issue linked for discussion. Pull requests can become cluttered very quickly and are not a good place for discussion.