mirror of
https://github.com/tycrek/degoogle
synced 2024-11-04 12:00:20 +00:00
2.1 KiB
2.1 KiB
Contributing
Contributing is simple enough, just make sure to try and follow these guidelines to ensure your Issue/PR is dealt with faster:
- If possible, please open an Issue before opening a Pull Request. We can use Issue's for discussion on adding/removing/modifying alternatives.
- English only for Issues & Pull Requests.
- Try to fill out as much info as you can. This makes it easier for me to quickly approve changes.
- No personal opinions on why a service should be removed. Links to articles with details is much more helpful.
- Try to use the Issue templates if possible, but they are not necessary.
- Try to limit yourself to ONE alternative per Issue. Pull Requests are OK to have multiple additions.
- 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 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.
Formatting
To keep the guide consistent & clean, try to follow these formatting rules:
- The alternative entry must be indented with two spaces before the hyphen.
- Use
[square brackets](regular brackets)
for links instead of referenced links[square brackets][1]
- Separate the link and the description with space, hypen, space.
- If applicable, add an "eyes" disclaimer. Eyes disclaimers must be in bold. The number and "eyes" are connected with a hyphen.
- Try to avoid spelling mistakes. If they show up I can always fix them.
Sample
- Google Service
- [Alternative Name](https://example.org) - A brief description of the alternative.
- [Another one](https://example.com) - **9-eyes** - If applicable, mention paid plans.
- Google Service
- Alternative Name - A brief description of the alternative.
- Another one - 9-eyes - If applicable, mention paid plans.