ch0ic3/awesome
1
0
Fork 0
mirror of https://github.com/sindresorhus/awesome.git synced 2024-12-24 01:45:25 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Sync PR template with ToC rules about silenced sections (#1860)

Browse Source 
Co-authored-by: Sindre Sorhus <sindresorhus@gmail.com>
This commit is contained in:
Kevin Deldycke 2020-10-12 18:11:54 +02:00 committed by GitHub
parent 21421ba38a
commit 488c1051a3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
pull_request_template.md
View File

@ -75,15 +75,19 @@
- Should be named `Contents`, not `Table of Contents`. - Should be named `Contents`, not `Table of Contents`.
- Should be the first section in the list. - Should be the first section in the list.
- Should only have one level of [nested lists](https://commonmark.org/help/tutorial/10-nestedLists.html), preferably none. - Should only have one level of [nested lists](https://commonmark.org/help/tutorial/10-nestedLists.html), preferably none.
- Must not feature `Contributing` or `Footnotes` sections.
- Has an appropriate license. - Has an appropriate license.
- **We strongly recommend the [CC0 license](https://creativecommons.org/publicdomain/zero/1.0/), but any [Creative Commons license](https://creativecommons.org/choose/) will work.** - **We strongly recommend the [CC0 license](https://creativecommons.org/publicdomain/zero/1.0/), but any [Creative Commons license](https://creativecommons.org/choose/) will work.**
- Tip: You can quickly add it to your repo by going to this URL: `https://github.com/<user>/<repo>/community/license/new?branch=master&template=cc0-1.0` (replace `<user>` and `<repo>` accordingly). - Tip: You can quickly add it to your repo by going to this URL: `https://github.com/<user>/<repo>/community/license/new?branch=master&template=cc0-1.0` (replace `<user>` and `<repo>` accordingly).
- A code license like MIT, BSD, Apache, GPL, etc, is not acceptable. Neither are WTFPL and [Unlicense](https://unlicense.org). - A code license like MIT, BSD, Apache, GPL, etc, is not acceptable. Neither are WTFPL and [Unlicense](https://unlicense.org).
- Place a file named `license` or `LICENSE` in the repo root with the license text. - Place a file named `license` or `LICENSE` in the repo root with the license text.
- **Do not** add the license name or text to the readme. GitHub already shows the license name at the top of the repo. - **Do not** add the license name, text, or a `Licence` section to the readme. GitHub already shows the license name and link to the full text at the top of the repo.
- To verify that you've read all the guidelines, please comment on your pull request with just the word `unicorn`. - To verify that you've read all the guidelines, please comment on your pull request with just the word `unicorn`.
- Has [contribution guidelines](awesome.md#include-contribution-guidelines). - Has [contribution guidelines](awesome.md#include-contribution-guidelines).
- The file should be named `contributing.md`. Casing is up to you. - The file should be named `contributing.md`. Casing is up to you.
- It can optionally be linked from the readme in a dedicated section titled `Contributing`, positioned at the top or bottom of the main content.
- The section should not appear in the Table of Contents.
- All non-important but necessary content (like extra copyright notices, hyperlinks to sources, pointers to expansive content, etc) should be grouped in a `Footnotes` section at the bottom of the readme. The section should not be present in the Table of Contents.
- Has consistent formatting and proper spelling/grammar. - Has consistent formatting and proper spelling/grammar.
- The link and description are separated by a dash. <br>Example: `- [AVA](…) - JavaScript test runner.` - The link and description are separated by a dash. <br>Example: `- [AVA](…) - JavaScript test runner.`
- The description starts with an uppercase character and ends with a period. - The description starts with an uppercase character and ends with a period.