From 5c464678cc3c9346f4dcac379925969062148156 Mon Sep 17 00:00:00 2001 From: tycrek Date: Mon, 9 Aug 2021 09:49:43 -0700 Subject: [PATCH] Revised Contributing Guidelines and all templates --- .../ISSUE_TEMPLATE/fix-update-alternative.md | 27 +++++--- .github/ISSUE_TEMPLATE/new-alternative.md | 66 +++++++++++-------- .github/ISSUE_TEMPLATE/other.md | 10 ++- .github/ISSUE_TEMPLATE/remove-alternative.md | 17 +++-- .github/PULL_REQUEST_TEMPLATE.md | 8 ++- CONTRIBUTING.md | 22 +++---- 6 files changed, 90 insertions(+), 60 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/fix-update-alternative.md b/.github/ISSUE_TEMPLATE/fix-update-alternative.md index 53259da..4a7bb36 100644 --- a/.github/ISSUE_TEMPLATE/fix-update-alternative.md +++ b/.github/ISSUE_TEMPLATE/fix-update-alternative.md @@ -1,14 +1,15 @@ --- name: Fix/update alternative about: Fix or update an exsting alternative. -title: "[FIX] Fix/update alternative" +title: "[FIX] Title here" labels: 'fix' assignees: '' --- -[//]: # ( Fill out to the best of your ability. ) -[//]: # ( If an item is not applicable, feel free to remove the line. ) + + + | Checklist | | | --------- | - | @@ -16,12 +17,22 @@ assignees: '' | Include my name in [CONTRIBUTORS.md] | yes/no | | I am affiliated with this alternative | yes/no | -### Details -- **Alternative name**: enter name here. Required -- **Error**: enter what might be wrong or what should be updated -- **Proposed changes**: enter what you suggest should be added -- **Additional details**: any additional details +### Alternative name + + + +### Error + + + +### Proposed changes + + + +### Additional details + + [CONTRIBUTING.md]: ../blob/master/CONTRIBUTING.md [CONTRIBUTORS.md]: ../blob/master/CONTRIBUTORS.md diff --git a/.github/ISSUE_TEMPLATE/new-alternative.md b/.github/ISSUE_TEMPLATE/new-alternative.md index 7cdc89b..af81ef4 100644 --- a/.github/ISSUE_TEMPLATE/new-alternative.md +++ b/.github/ISSUE_TEMPLATE/new-alternative.md @@ -1,14 +1,15 @@ --- name: New alternative about: Add a new alternative for a Google service -title: "[NEW] New alternative" +title: "[NEW] Title here" labels: 'new' assignees: '' --- -[//]: # ( Fill out to the best of your ability. ) -[//]: # ( If an item is not applicable, feel free to remove the line. ) + + + | Checklist | | | --------- | - | @@ -16,33 +17,40 @@ assignees: '' | Include my name in [CONTRIBUTORS.md] | yes/no | | I am affiliated with this alternative | yes/no | -### Details -- **General** - - **Alternative name**: alternative name here. Required - - **Alternative URL**: alternative URL here. Required - - **5/9/14 eyes**: yes/no/unknown - - **Description**: detail why this alternative should be added -- **FLOSS** - - Repository: link to source code repository - - Active: yes/no (any branch in source repo active within past four months, excluding translations) - - Download: F-Droid/Direct/Play Store (Direct is direct downloads, such as GitHub releases) - - Price: free/paid/freemium (free: no payments at all; paid: no free tier excluding trials; freemium: any mix of free tier and paid plans) - - Self-host: yes/no/only (use "only" if the only option is self hosting; for example, LibreOffice Online) -- **Encryption** - - HTTPS: yes/no - - E2EE: yes/no/optional - - Modern encryption: yes/no -- **Transparency** - - Public ownership: yes/no [Parent company name](https://parent.company.url) - - 3rd-party audits: yes/no [Link to audit history](https://audit.history.url) -- **Privacy** - - Anonymous payments: yes/no (these types of payments can include cash, cryptocurrency, gift cards) - - Analytics: yes/no (type of analytics) - - Captcha: recaptcha/hcaptcha/other -- **Extras** - - .onion address: .onion address - - Warrant canary: yes/no [Link to canary](https://warrant.canary.url) +### Alternative name + + + + +### Alternative Links + + + + +### Reason for adding + + + + +### Alternative details + + +- **5/9/14 eyes**: +- **Pricing**: +- **Self-hosting**: + +#### Additional details + + [CONTRIBUTING.md]: ../blob/master/CONTRIBUTING.md [CONTRIBUTORS.md]: ../blob/master/CONTRIBUTORS.md diff --git a/.github/ISSUE_TEMPLATE/other.md b/.github/ISSUE_TEMPLATE/other.md index aa38cd2..9b4c094 100644 --- a/.github/ISSUE_TEMPLATE/other.md +++ b/.github/ISSUE_TEMPLATE/other.md @@ -1,14 +1,15 @@ --- name: Other about: Anything else that does not fit the other templates. Blank issues are not permitted. -title: "[OTHER]" +title: "[OTHER] Title here" labels: 'other' assignees: '' --- -[//]: # ( Fill out to the best of your ability. ) -[//]: # ( If an item is not applicable, feel free to remove the line. ) + + + | Checklist | | | --------- | - | @@ -16,7 +17,10 @@ assignees: '' | Include my name in [CONTRIBUTORS.md] | yes/no | | I am affiliated with this alternative | yes/no | + ### Details + + [CONTRIBUTING.md]: ../blob/master/CONTRIBUTING.md [CONTRIBUTORS.md]: ../blob/master/CONTRIBUTORS.md diff --git a/.github/ISSUE_TEMPLATE/remove-alternative.md b/.github/ISSUE_TEMPLATE/remove-alternative.md index bb74cce..74f6909 100644 --- a/.github/ISSUE_TEMPLATE/remove-alternative.md +++ b/.github/ISSUE_TEMPLATE/remove-alternative.md @@ -1,14 +1,15 @@ --- name: Remove alternative about: Provide details on why an existing alternative should be removed. -title: "[REMOVE] Remove alternative" +title: "[REMOVE] Title here" labels: 'remove' assignees: '' --- -[//]: # ( Fill out to the best of your ability. ) -[//]: # ( If an item is not applicable, feel free to remove the line. ) + + + | Checklist | | | --------- | - | @@ -16,10 +17,14 @@ assignees: '' | Include my name in [CONTRIBUTORS.md] | yes/no | | I am affiliated with this alternative | yes/no | -### Details -- **Alternative name**: enter name here. Required -- **Reason**: detail why this alternative should be removed. Include any relevant links +### Alternative name + + + +### Reason + + [CONTRIBUTING.md]: ../blob/master/CONTRIBUTING.md [CONTRIBUTORS.md]: ../blob/master/CONTRIBUTORS.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 6c800f5..50c7eec 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,11 +1,15 @@ -[//]: # ( Every alternative in your pull request MUST have an linked issue) + | Checklist | | | --------- | - | | **I have read the guidelines in [CONTRIBUTING.md]** | yes/no | | Include my name in [CONTRIBUTORS.md] | yes/no | -| Any alternatives in this PR have a linked issue | yes/no | | I am affiliated with this alternative (if applicable) | yes/no | + +### Details + + + [CONTRIBUTING.md]: ../blob/master/CONTRIBUTING.md [CONTRIBUTORS.md]: ../blob/master/CONTRIBUTORS.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 93089e3..512ed4f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,37 +1,35 @@ # Contributing -###### Last revised: May 11th, 2021 +###### 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. - -## Issue & pull request templates - -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. +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](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** +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. +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 +[new Issue]: https://github.com/tycrek/degoogle/issues/new/choose [CONTRIBUTORS.md]: https://github.com/tycrek/degoogle/blob/master/CONTRIBUTORS.md