Update contributing to fit format

This commit is contained in:
pluja 2021-05-21 19:09:05 +02:00
parent 4dc231b703
commit dd50cc3ff9
1 changed files with 16 additions and 12 deletions

View File

@ -12,26 +12,30 @@ To add a new section copy the following template and complete with the informati
``` ```
## Section Title ## Section Title
<img width="16" src="misc/forbidden.png"> </img> **Avoid**: <img width="16" src="misc/forbidden.png"> </img> **Avoid**
[OPTIONAL EXPLANATION OF WHY THESE SERVICES ARE BAD] [OPTIONAL EXPLANATION OF WHY THESE SERVICES ARE BAD]
* Bad Service 1
* Bad Service 2
* Bad Service 3
<img width="16" src="misc/check.png"> </img> **Instead use:** - Bad Service 1
- Bad Service 2
- Bad Service 3
<img width="16" src="misc/check.png"> </img> **Instead use**
[OPTIONAL EXPLANATION OF WHY THESE SERVICES ARE GOOD] [OPTIONAL EXPLANATION OF WHY THESE SERVICES ARE GOOD]
* [Good Service 1](https://link-to-source-or-page1) - Little description of the service
* [Good Service 2](https://link-to-source-or-page2) - Little description of the service
* [Good Service 2](https://link-to-source-or-page3) - Little description of the service
```
You also need to add the section to the **Table of Contents (Index)** at the top of the document:
`* [Section Title](#section-title)` - [Good Service 1](https://link-to-source-or-page1) - Little description of the service.
- [Good Service 2](https://link-to-source-or-page2) - Little description of the service.
- [Good Service 2](https://link-to-source-or-page3) - Little description of the service.
```
You also need to add the section to the **Table of Contents (Contents)** at the top of the document:
`- [Section Title](#section-title)`
### Adding a new service ### Adding a new service
To add a new service just take the following template and add it to the section where it belongs: To add a new service just take the following template and add it to the section where it belongs:
`* [Service Name](https://link-to-source-or-page) - Little description of the service` `- [Service Name](https://link-to-source-or-page) - Little description of the service`
> You can add either a *good* (use) or a *bad* (avoid) service. > You can add either a *good* (use) or a *bad* (avoid) service.