From a59f934e4fe704880a3e2d5df6a06f7123ebda9f Mon Sep 17 00:00:00 2001 From: Josh Moore Date: Mon, 25 May 2020 08:10:24 -0600 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 22 ++-------------------- 1 file changed, 2 insertions(+), 20 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f440705..494aab9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,24 +12,6 @@ Contributing is simple enough, just make sure to try and follow these guidelines 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 +# What to edit -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. +As of May 24/25 2020, the `README.md` file is automatically generated. Please update either `degoogle.yml` or the files in `md/`.