gaspersic/awesome
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Improve pull request template

Browse Source
This commit is contained in:
Sindre Sorhus
2018-04-08 17:16:00 +07:00
parent eca040f597
commit 38fe469625
1 changed files with 39 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
pull_request_template.md
View File

@ -9,16 +9,22 @@
**[Explain what this list is about and why it should be included here]** **[Explain what this list is about and why it should be included here]**
# By submitting this pull request I confirm I've read and complied with the below requirements. ### By submitting this pull request I confirm I've read and complied with the below requirements 🖖
**Please read it multiple times. I spent a lot of time on these guidelines and most people miss a lot.** **Please read it multiple times. I spent a lot of time on these guidelines and most people miss a lot.**
## Requirements for your pull request
- I have read and understood the [contribution guidelines](https://github.com/sindresorhus/awesome/blob/master/contributing.md) and the [instructions for creating a list](https://github.com/sindresorhus/awesome/blob/master/create-list.md). - I have read and understood the [contribution guidelines](https://github.com/sindresorhus/awesome/blob/master/contributing.md) and the [instructions for creating a list](https://github.com/sindresorhus/awesome/blob/master/create-list.md).
- This pull request has a descriptive title.<br>For example, `Add Name of List`, not `Update readme.md` or `Add awesome list`. - This pull request has a descriptive title.<br>For example, `Add Name of List`, not `Update readme.md` or `Add awesome list`.
- The entry in the Awesome list should: - The entry in the Awesome list should:
- Include a short description about the project/theme of the list. **It should not describe the list itself.**<br>Example: `- [Fish](…) - User-friendly shell.`, not `- [Fish](…) - Resources for Fish.`. - Include a short description about the project/theme of the list. **It should not describe the list itself.**<br>Example: `- [Fish](…) - User-friendly shell.`, not `- [Fish](…) - Resources for Fish.`.
- Be added at the bottom of the appropriate category. - Be added at the bottom of the appropriate category.
- The list I'm submitting complies with these requirements: - The list I'm submitting complies with these requirements:
## Requirements for your Awesome list
- **Has been around for at least 30 days.**<br>That means 30 days from either the first real commit or when it was open-sourced. Whatever is most recent. - **Has been around for at least 30 days.**<br>That means 30 days from either the first real commit or when it was open-sourced. Whatever is most recent.
- It's the result of hard work and the best I could possibly produce. - It's the result of hard work and the best I could possibly produce.
- Non-generated Markdown file in a GitHub repo. - Non-generated Markdown file in a GitHub repo.
@ -47,7 +53,7 @@
- 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.
- Drop all the `A` / `An` prefixes in the descriptions.
- Consistent and correct naming. For example, `Node.js`, not `NodeJS` or `node.js`. - Consistent and correct naming. For example, `Node.js`, not `NodeJS` or `node.js`.
- Doesn't include a Travis badge.<br>You can still use Travis for list linting, but the badge has no value in the readme. - Doesn't include a Travis badge.<br>You can still use Travis for list linting, but the badge has no value in the readme.
- Go to the top and read it again.
Go to the top and read it again.