Archives/degoogle
2
0
Fork 0
mirror of https://github.com/tycrek/degoogle synced 2024-11-04 12:00:20 +00:00
Code Issues Projects Releases Wiki Activity

Update CONTRIBUTING.md

Browse Source
This commit is contained in:
Josh Moore 2020-06-11 08:33:50 -06:00 committed by GitHub
parent 847db5b579
commit bf2f061379
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
CONTRIBUTING.md
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.