diff --git a/pull_request_template.md b/pull_request_template.md index e4b2729..9855318 100644 --- a/pull_request_template.md +++ b/pull_request_template.md @@ -4,9 +4,9 @@ -**[Insert URL to the list here]** +**[Insert the URL to be listed]** -**[Explain what the project is about and why it should be included here]** +**[Explain what the project is about and why it should be listed]** # By submitting this pull request I confirm I've read and complied with the below requirements. @@ -20,8 +20,19 @@ - Go to the [contribution guidelines](https://github.com/veggiemonk/awesome-docker/blob/master/CONTRIBUTING.md) and read it again. -RULES (because you probably didn't read the guidelines): -* ORDER: The entries are in lexical order (English letter order) -* CREDIT: Each entry must contains the name of the author with a link to its github account! -* LINK: the link should be to the source code (https://github/account/project) not the website (https://myproject.io <- no!) -* MONEY: indicates if one needs a paying subscription to use that project you could just add ($$$) next to the name ([my project - $$$] (link to my project) ) +**RULES (because you probably didn't read the guidelines):** + +Links will be tested with [awesome_bot](https://github.com/dkhamsing/awesome_bot). Please make sure your URL to be listed is unique (do some search queries), otherwise put a link at the end of `README.md` file. + +- FORMAT + - Use the following format: `[Name](Link) - Description.` + - `[Name]` should be the title of the project + - `(Link)` should be pointing to a GitHub repository, not to a website + - `Description.` should end with a full stop/period + - For GitHub repositories, add the name of the author with a link to its GitHub account after the description, like `By [@author](GitHub account)` +- ORDER: The entries are in lexical order (English letter order) +- LABEL (Optional) + - $$$ indicates if one needs a paying subscription to use the project. +
Add $$$ next to the project name like `[Name $$$](Link)` + - BETA indicates that the project is in beta phase. +
Add BETA next to the project name like `[Name BETA](Link)`