From dd50cc3ff9eb9f6b6614ff92bc5cb597b2554607 Mon Sep 17 00:00:00 2001 From: pluja Date: Fri, 21 May 2021 19:09:05 +0200 Subject: [PATCH] Update contributing to fit format --- misc/Contributing.md | 28 ++++++++++++++++------------ 1 file changed, 16 insertions(+), 12 deletions(-) diff --git a/misc/Contributing.md b/misc/Contributing.md index ad49005..b8c7ab6 100644 --- a/misc/Contributing.md +++ b/misc/Contributing.md @@ -12,26 +12,30 @@ To add a new section copy the following template and complete with the informati ``` ## Section Title - **Avoid**: + **Avoid** + [OPTIONAL EXPLANATION OF WHY THESE SERVICES ARE BAD] -* Bad Service 1 -* Bad Service 2 -* Bad Service 3 - **Instead use:** +- Bad Service 1 +- Bad Service 2 +- Bad Service 3 + + **Instead use** + [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 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.