From db7688d94fa35794eb7636a9155bd5b5e67a4b61 Mon Sep 17 00:00:00 2001 From: tycrek Date: Mon, 9 Mar 2020 12:16:10 -0600 Subject: [PATCH] Added formatting rules for contributing. --- CONTRIBUTING.md | 24 +++++++++++++++++++++++- README.md | 5 +---- 2 files changed, 24 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1e5e1e1..0a415c2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,4 +9,26 @@ Contributing is simple enough, just make sure to try and follow these guidelines 5. Try to limit yourself to ONE alternative per Issue. Pull Requests are OK to have multiple additions. 6. 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. +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. + +## Formatting + +To keep the guide consistent & clean, try to follow these formatting rules: + +1. The alternative entry must be **indented with two spaces** before the hyphen. +2. Use `[square brackets](regular brackets)` for links instead of referenced links `[square brackets][1]` +3. Separate the link and the description with **space, hypen, space**. +4. If applicable, add an "eyes" disclaimer. Eyes disclaimers must be in bold. The number and "eyes" are connected with a hyphen. +5. Try to avoid spelling mistakes. If they show up I can always fix them. + +**Sample** + +```markdown +- 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](https://alternative.link) - A brief description of the alternative. + - [Another one](https://example.com) - **9-eyes** - If applicable, mention paid plans. diff --git a/README.md b/README.md index 73f3cf3..e6385f3 100644 --- a/README.md +++ b/README.md @@ -28,10 +28,7 @@ If you want to help out with the project, here are some ideas (submit **Issues** - Host a mirror or clone the [repo](https://github.com/tycrek/degoogle). If you host a mirror, let me know and I can add it to the mirrors list. - Anything else relating to any part of this guide, whether it's Google related or not. -**Want to help out in another way?** - -- **Share** this guide with everyone you know. Let them know why privacy matters and why they should care about it. Don't force it on them, but carefully ease them into it and don't scare them away from staying secure. -- **Donate** to non-profit organizations that support online privacy and security (see the [r/privacy](https://reddit.com/r/privacy) sidebar) +When contributing, please try to follow the rules outlined in [CONTRIBUTING.md](https://github.com/tycrek/degoogle/blob/master/CONTRIBUTING.md). # Browser extensions