mirror of
https://github.com/tycrek/degoogle.git
synced 2025-08-01 12:40:09 +02:00
Added formatting rules for contributing.
This commit is contained in:
@@ -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.
|
||||
|
Reference in New Issue
Block a user