Revised Contributing Guidelines and all templates
This commit is contained in:
parent
dc27acf546
commit
5c464678cc
|
@ -1,14 +1,15 @@
|
||||||
---
|
---
|
||||||
name: Fix/update alternative
|
name: Fix/update alternative
|
||||||
about: Fix or update an exsting alternative.
|
about: Fix or update an exsting alternative.
|
||||||
title: "[FIX] Fix/update alternative"
|
title: "[FIX] Title here"
|
||||||
labels: 'fix'
|
labels: 'fix'
|
||||||
assignees: ''
|
assignees: ''
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
[//]: # ( Fill out to the best of your ability. )
|
<!-- Fill out to the best of your ability. -->
|
||||||
[//]: # ( If an item is not applicable, feel free to remove the line. )
|
<!-- If an item is not applicable, feel free to remove the line. -->
|
||||||
|
|
||||||
|
|
||||||
| Checklist | |
|
| Checklist | |
|
||||||
| --------- | - |
|
| --------- | - |
|
||||||
|
@ -16,12 +17,22 @@ assignees: ''
|
||||||
| Include my name in [CONTRIBUTORS.md] | yes/no |
|
| Include my name in [CONTRIBUTORS.md] | yes/no |
|
||||||
| I am affiliated with this alternative | yes/no |
|
| I am affiliated with this alternative | yes/no |
|
||||||
|
|
||||||
### Details
|
|
||||||
|
|
||||||
- **Alternative name**: enter name here. Required
|
### Alternative name
|
||||||
- **Error**: enter what might be wrong or what should be updated
|
<!-- Which alternative needs to be fixed or updated? -->
|
||||||
- **Proposed changes**: enter what you suggest should be added
|
|
||||||
- **Additional details**: any additional details
|
|
||||||
|
### Error
|
||||||
|
<!-- What might be wrong or what should be updated? -->
|
||||||
|
|
||||||
|
|
||||||
|
### Proposed changes
|
||||||
|
<!-- What do you suggest be changed? -->
|
||||||
|
|
||||||
|
|
||||||
|
### Additional details
|
||||||
|
<!-- Add any additional details here. -->
|
||||||
|
|
||||||
|
|
||||||
[CONTRIBUTING.md]: ../blob/master/CONTRIBUTING.md
|
[CONTRIBUTING.md]: ../blob/master/CONTRIBUTING.md
|
||||||
[CONTRIBUTORS.md]: ../blob/master/CONTRIBUTORS.md
|
[CONTRIBUTORS.md]: ../blob/master/CONTRIBUTORS.md
|
||||||
|
|
|
@ -1,14 +1,15 @@
|
||||||
---
|
---
|
||||||
name: New alternative
|
name: New alternative
|
||||||
about: Add a new alternative for a Google service
|
about: Add a new alternative for a Google service
|
||||||
title: "[NEW] New alternative"
|
title: "[NEW] Title here"
|
||||||
labels: 'new'
|
labels: 'new'
|
||||||
assignees: ''
|
assignees: ''
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
[//]: # ( Fill out to the best of your ability. )
|
<!-- Fill out to the best of your ability. -->
|
||||||
[//]: # ( If an item is not applicable, feel free to remove the line. )
|
<!-- If an item is not applicable, feel free to remove the line. -->
|
||||||
|
|
||||||
|
|
||||||
| Checklist | |
|
| Checklist | |
|
||||||
| --------- | - |
|
| --------- | - |
|
||||||
|
@ -16,33 +17,40 @@ assignees: ''
|
||||||
| Include my name in [CONTRIBUTORS.md] | yes/no |
|
| Include my name in [CONTRIBUTORS.md] | yes/no |
|
||||||
| I am affiliated with this alternative | yes/no |
|
| I am affiliated with this alternative | yes/no |
|
||||||
|
|
||||||
### Details
|
|
||||||
|
|
||||||
- **General**
|
### Alternative name
|
||||||
- **Alternative name**: alternative name here. Required
|
<!-- Name of the alternative you wish to add -->
|
||||||
- **Alternative URL**: alternative URL here. Required
|
<!-- Please also include the section you feel it belongs best in -->
|
||||||
- **5/9/14 eyes**: yes/no/unknown
|
|
||||||
- **Description**: detail why this alternative should be added
|
|
||||||
- **FLOSS**
|
### Alternative Links
|
||||||
- Repository: link to source code repository
|
<!-- URL of the alternative you wish to add -->
|
||||||
- Active: yes/no (any branch in source repo active within past four months, excluding translations)
|
<!-- Please include any websites, source code repositories, F-Droid pages, or other relavant links -->
|
||||||
- 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)
|
### Reason for adding
|
||||||
- **Encryption**
|
<!-- Why is this alternative necessary? -->
|
||||||
- HTTPS: yes/no
|
<!-- Don't use opinions and try to be objective -->
|
||||||
- E2EE: yes/no/optional
|
|
||||||
- Modern encryption: yes/no
|
|
||||||
- **Transparency**
|
### Alternative details
|
||||||
- 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**
|
These are optional, but will help accelrate the review process. Fill out to the best of your ability.
|
||||||
- Anonymous payments: yes/no (these types of payments can include cash, cryptocurrency, gift cards)
|
|
||||||
- Analytics: yes/no (type of analytics)
|
- For more info on 5/9/14 eyes, please check here: https://restoreprivacy.com/5-eyes-9-eyes-14-eyes/
|
||||||
- Captcha: recaptcha/hcaptcha/other
|
- For pricing, please specify one of: free, paid, freemium
|
||||||
- **Extras**
|
- For self-hosting, please indicate if self-hosting is possible, not possible, or the only option
|
||||||
- .onion address: .onion address
|
|
||||||
- Warrant canary: yes/no [Link to canary](https://warrant.canary.url)
|
-->
|
||||||
|
|
||||||
|
- **5/9/14 eyes**:
|
||||||
|
- **Pricing**:
|
||||||
|
- **Self-hosting**:
|
||||||
|
|
||||||
|
#### Additional details
|
||||||
|
<!-- Use this space to add any other relevant information about the alternative -->
|
||||||
|
|
||||||
|
|
||||||
[CONTRIBUTING.md]: ../blob/master/CONTRIBUTING.md
|
[CONTRIBUTING.md]: ../blob/master/CONTRIBUTING.md
|
||||||
[CONTRIBUTORS.md]: ../blob/master/CONTRIBUTORS.md
|
[CONTRIBUTORS.md]: ../blob/master/CONTRIBUTORS.md
|
||||||
|
|
|
@ -1,14 +1,15 @@
|
||||||
---
|
---
|
||||||
name: Other
|
name: Other
|
||||||
about: Anything else that does not fit the other templates. Blank issues are not permitted.
|
about: Anything else that does not fit the other templates. Blank issues are not permitted.
|
||||||
title: "[OTHER]"
|
title: "[OTHER] Title here"
|
||||||
labels: 'other'
|
labels: 'other'
|
||||||
assignees: ''
|
assignees: ''
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
[//]: # ( Fill out to the best of your ability. )
|
<!-- Fill out to the best of your ability. -->
|
||||||
[//]: # ( If an item is not applicable, feel free to remove the line. )
|
<!-- If an item is not applicable, feel free to remove the line. -->
|
||||||
|
|
||||||
|
|
||||||
| Checklist | |
|
| Checklist | |
|
||||||
| --------- | - |
|
| --------- | - |
|
||||||
|
@ -16,7 +17,10 @@ assignees: ''
|
||||||
| Include my name in [CONTRIBUTORS.md] | yes/no |
|
| Include my name in [CONTRIBUTORS.md] | yes/no |
|
||||||
| I am affiliated with this alternative | yes/no |
|
| I am affiliated with this alternative | yes/no |
|
||||||
|
|
||||||
|
|
||||||
### Details
|
### Details
|
||||||
|
<!-- Describe your Issue -->
|
||||||
|
|
||||||
|
|
||||||
[CONTRIBUTING.md]: ../blob/master/CONTRIBUTING.md
|
[CONTRIBUTING.md]: ../blob/master/CONTRIBUTING.md
|
||||||
[CONTRIBUTORS.md]: ../blob/master/CONTRIBUTORS.md
|
[CONTRIBUTORS.md]: ../blob/master/CONTRIBUTORS.md
|
||||||
|
|
|
@ -1,14 +1,15 @@
|
||||||
---
|
---
|
||||||
name: Remove alternative
|
name: Remove alternative
|
||||||
about: Provide details on why an existing alternative should be removed.
|
about: Provide details on why an existing alternative should be removed.
|
||||||
title: "[REMOVE] Remove alternative"
|
title: "[REMOVE] Title here"
|
||||||
labels: 'remove'
|
labels: 'remove'
|
||||||
assignees: ''
|
assignees: ''
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
[//]: # ( Fill out to the best of your ability. )
|
<!-- Fill out to the best of your ability. -->
|
||||||
[//]: # ( If an item is not applicable, feel free to remove the line. )
|
<!-- If an item is not applicable, feel free to remove the line. -->
|
||||||
|
|
||||||
|
|
||||||
| Checklist | |
|
| Checklist | |
|
||||||
| --------- | - |
|
| --------- | - |
|
||||||
|
@ -16,10 +17,14 @@ assignees: ''
|
||||||
| Include my name in [CONTRIBUTORS.md] | yes/no |
|
| Include my name in [CONTRIBUTORS.md] | yes/no |
|
||||||
| I am affiliated with this alternative | yes/no |
|
| I am affiliated with this alternative | yes/no |
|
||||||
|
|
||||||
### Details
|
|
||||||
|
|
||||||
- **Alternative name**: enter name here. Required
|
### Alternative name
|
||||||
- **Reason**: detail why this alternative should be removed. Include any relevant links
|
<!-- Which alternative needs to be removed? -->
|
||||||
|
|
||||||
|
|
||||||
|
### Reason
|
||||||
|
<!-- Why should this alternative be removed? -->
|
||||||
|
|
||||||
|
|
||||||
[CONTRIBUTING.md]: ../blob/master/CONTRIBUTING.md
|
[CONTRIBUTING.md]: ../blob/master/CONTRIBUTING.md
|
||||||
[CONTRIBUTORS.md]: ../blob/master/CONTRIBUTORS.md
|
[CONTRIBUTORS.md]: ../blob/master/CONTRIBUTORS.md
|
||||||
|
|
|
@ -1,11 +1,15 @@
|
||||||
[//]: # ( Every alternative in your pull request MUST have an linked issue)
|
<!-- If your Pull Request is related to an alternative, make sure there is a corrosponding Issue for discussion. -->
|
||||||
|
|
||||||
| Checklist | |
|
| Checklist | |
|
||||||
| --------- | - |
|
| --------- | - |
|
||||||
| **I have read the guidelines in [CONTRIBUTING.md]** | yes/no |
|
| **I have read the guidelines in [CONTRIBUTING.md]** | yes/no |
|
||||||
| Include my name in [CONTRIBUTORS.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 |
|
| I am affiliated with this alternative (if applicable) | yes/no |
|
||||||
|
|
||||||
|
|
||||||
|
### Details
|
||||||
|
<!-- Optional if details exist in a linked Issue. If that is the case, link to the Issue here. -->
|
||||||
|
|
||||||
|
|
||||||
[CONTRIBUTING.md]: ../blob/master/CONTRIBUTING.md
|
[CONTRIBUTING.md]: ../blob/master/CONTRIBUTING.md
|
||||||
[CONTRIBUTORS.md]: ../blob/master/CONTRIBUTORS.md
|
[CONTRIBUTORS.md]: ../blob/master/CONTRIBUTORS.md
|
||||||
|
|
|
@ -1,37 +1,35 @@
|
||||||
# Contributing
|
# Contributing
|
||||||
|
|
||||||
###### Last revised: May 11th, 2021
|
###### Last revised: August 9th, 2021
|
||||||
|
|
||||||
|
###### Templates revised: August 9th, 2021
|
||||||
|
|
||||||
## General rules
|
## General rules
|
||||||
|
|
||||||
1. **English only** for issues & pull requests.
|
1. **English only** for issues & pull requests.
|
||||||
2. **Do not edit `README.md`!** This file is automatically generated.
|
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.
|
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.
|
||||||
## 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.
|
|
||||||
|
|
||||||
## How to submit a change
|
## How to submit a change
|
||||||
|
|
||||||
### A: I am not familiar with GitHub or Pull Requests
|
### A: I am not familiar with GitHub or Pull Requests
|
||||||
|
|
||||||
1. Open a [new Issue](https://github.com/tycrek/degoogle/issues/new/choose)
|
1. Open a [new Issue].
|
||||||
2. Select a template to use. If in doubt, use **[Other]**
|
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)
|
3. Fill out the information to the best of your ability.
|
||||||
4. When you are finished, click **Submit new issue**
|
4. When you are finished, click **Submit new issue**.
|
||||||
|
|
||||||
### B: I have used GitHub Pull Requests
|
### B: I have used GitHub Pull Requests
|
||||||
|
|
||||||
1. Create your Pull Request with your changes.
|
1. Create your Pull Request with your changes.
|
||||||
- Remember to **not** edit `README.md`!
|
- Remember to **not** edit `README.md`!
|
||||||
- As with Issues, fill out the template as best you can.
|
- 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
|
## 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.
|
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
|
[CONTRIBUTORS.md]: https://github.com/tycrek/degoogle/blob/master/CONTRIBUTORS.md
|
||||||
|
|
Loading…
Reference in New Issue