From bf2f0613794c84aafd6eb5918f16a05adf13db39 Mon Sep 17 00:00:00 2001 From: Josh Moore Date: Thu, 11 Jun 2020 08:33:50 -0600 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 25 ++++++++++++++----------- 1 file changed, 14 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 494aab9..d8c9b39 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,17 +1,20 @@ # Contributing -Contributing is simple enough, just make sure to try and follow these guidelines to ensure your Issue/PR is dealt with faster: +### General -1. If possible, please [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. Try to fill out as much info as you can. This makes it easier for me to quickly approve changes. -4. No personal opinions on why a service should be removed. Links to articles with details is much more helpful. -5. Try to use the Issue templates if possible, but they are not necessary. -6. Try to limit yourself to ONE alternative per Issue. Pull Requests are OK to have multiple additions. +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](../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. + +### New alternatives + +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. -If you submitted a change that made it into the guide but don't have your Reddit or GitHub username on the [CONTRIBUTORS.md](https://github.com/tycrek/degoogle/blob/master/CONTRIBUTORS.md) list, let me know! Sometimes I forget. Alternatively, if your username is on the list and you do *not* want it there, let me know. +### Removing alternatives -# What to edit - -As of May 24/25 2020, the `README.md` file is automatically generated. Please update either `degoogle.yml` or the files in `md/`. +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.