This repository has been archived by the owner on Aug 26, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 394
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #159 from tycrek/tycrek-contributing
Update Templates and CONTRIBUTING.md per #131
- Loading branch information
Showing
5 changed files
with
85 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. | ||
7. Check to see if the alternative you want added already exists in the guide. | ||
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 | ||
|
||
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. | ||
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. | ||
|
||
# What to edit | ||
### Removing alternatives | ||
|
||
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. |