Merge pull request #159 from tycrek/tycrek-contributing

Update Templates and CONTRIBUTING.md per #131
This commit is contained in:
Josh Moore 2020-06-11 12:57:35 -06:00 committed by GitHub
commit 6468f11772
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 85 additions and 21 deletions

View File

@ -7,10 +7,19 @@ assignees: ''
---
**Service name**: *enter name here. Required.*
[//]: # ( Fill out to the best of your ability. )
[//]: # ( If an item is not applicable, feel free to leave it blank. )
[//]: # ( Mark off checkbox items by putting an x in between the [ ] without spaces, i.e. `[x]` )
**Error**: *enter what might be wrong or what should be updated.*
### Checklist
**Proposed changes**: *enter what you suggest should be added.*
- [ ] **I am affiliated with this alternative**
- [ ] **I have read the rules outlined in [CONTRIBUTING.md](https://github.com/tycrek/degoogle/blob/master/CONTRIBUTING.md)**
- [ ] **Include my name in [CONTRIBUTORS.md](https://github.com/tycrek/degoogle/blob/master/CONTRIBUTORS.md)**
**Additional details**: *any additional details*
### 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 }

View File

@ -7,10 +7,40 @@ assignees: ''
---
**Service name**: *enter service name here. Required*
[//]: # ( Fill out to the best of your ability. )
[//]: # ( If an item is not applicable, such as HTTPS for an App, feel free to leave it blank. )
[//]: # ( Mark off checkbox items by putting an x in between the [ ] without spaces, i.e. `[x]` )
**Service URL**: *service URL here. Required*
### Checklist
**5/9/14 eyes?**: yes/no/unknown
- [ ] **I am affiliated with this alternative**
- [ ] **I have read the rules outlined in [CONTRIBUTING.md](https://github.com/tycrek/degoogle/blob/master/CONTRIBUTING.md)**
- [ ] **Include my name in [CONTRIBUTORS.md](https://github.com/tycrek/degoogle/blob/master/CONTRIBUTORS.md)**
**Description**: *detail why this service should be added. Include details such as pricing and privacy.*
### 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)

View File

@ -8,4 +8,15 @@ assignees: ''
---
[//]: # ( Fill out to the best of your ability. )
[//]: # ( If an item is not applicable, feel free to leave it blank. )
[//]: # ( Mark off checkbox items by putting an x in between the [ ] without spaces, i.e. `[x]` )
### Checklist
- [ ] **I am affiliated with this alternative**
- [ ] **I have read the rules outlined in [CONTRIBUTING.md](https://github.com/tycrek/degoogle/blob/master/CONTRIBUTING.md)**
- [ ] **Include my name in [CONTRIBUTORS.md](https://github.com/tycrek/degoogle/blob/master/CONTRIBUTORS.md)**
### Details

View File

@ -7,6 +7,17 @@ assignees: ''
---
**Service name**: *enter service name here. Required*
[//]: # ( Fill out to the best of your ability. )
[//]: # ( If an item is not applicable, feel free to leave it blank. )
[//]: # ( Mark off checkbox items by putting an x in between the [ ] without spaces, i.e. `[x]` )
**Reason**: *detail why this service should be removed. Include any relevant links. **This is not the place for personal opinions**.*
### Checklist
- [ ] **I am affiliated with this alternative**
- [ ] **I have read the rules outlined in [CONTRIBUTING.md](https://github.com/tycrek/degoogle/blob/master/CONTRIBUTING.md)**
- [ ] **Include my name in [CONTRIBUTORS.md](https://github.com/tycrek/degoogle/blob/master/CONTRIBUTORS.md)**
### Details
- **Alternative name**: { Enter name here. Required }
- **Reason**: { detail why this alternative should be removed. Include any relevant links }

View File

@ -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.