From 6bd693069d7d10758f2ad3bef0dea4b8fd63c362 Mon Sep 17 00:00:00 2001 From: Josh Moore Date: Sat, 17 Apr 2021 13:06:59 -0600 Subject: [PATCH 1/2] Revised Contributing guidelines (closes #326) Made the rules less confusing and added some tips on how to make an Issue. --- CONTRIBUTING.md | 38 +++++++++++++++++++++++++++----------- 1 file changed, 27 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8b5a5c0..f6e628b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,21 +1,37 @@ # Contributing -###### Last revised: September 29th, 2020 +###### Last revised: April 17th, 2021 -## General +## General rules 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. +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. ## Issue & pull request templates -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. Using the templates is **required**. Blank issues or pull requests are not allowed & will be closed immediately. +2. **Not every field is required** but fill out as much info as you can. Feel free to delete sections that are not relevant. -## Pull requests +## How to submit a change -1. All pull requests regarding alternatives must have an issue linked for discussion. Pull requests can become cluttered very quickly and are not a good place for discussion. -2. If your PR is a quick fix or doesn't warrant an issue, an issue is not required, but it should be clear why the issue isn't required. +### A: I am not familiar with GitHub or Pull Requests + +1. Open a [new Issue](https://github.com/tycrek/degoogle/issues/new/choose) +2. Select a template to use. If in doubt, use **[Other]** +3. Fill out the information to the best of your ability: ![Template helper](https://user-images.githubusercontent.com/29926144/115123873-596cdd80-9f7c-11eb-8506-077d6bbd5433.png) +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. + +[Other]: https://github.com/tycrek/degoogle/issues/new?assignees=&labels=other&template=other.md&title=%5BOTHER%5D +[CONTRIBUTORS.md]: https://github.com/tycrek/degoogle/blob/master/CONTRIBUTORS.md From 257ff74c166c874734b529ba437be401ea61c54f Mon Sep 17 00:00:00 2001 From: Josh Moore Date: Tue, 11 May 2021 17:29:35 -0600 Subject: [PATCH 2/2] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f6e628b..93089e3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing -###### Last revised: April 17th, 2021 +###### Last revised: May 11th, 2021 ## General rules