Skip to content

Commit 022ced2

Browse files
committed
Improve contribution guidelines
1 parent 14a2c4c commit 022ced2

4 files changed

+9
-32
lines changed

.gitattributes

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
* text=auto
1+
* text=auto eol=lf
22
*.ai binary
33
readme.md merge=union

contributing.md

+2-25
Original file line numberDiff line numberDiff line change
@@ -2,32 +2,9 @@
22

33
Please note that this project is released with a [Contributor Code of Conduct](code-of-conduct.md). By participating in this project you agree to abide by its terms.
44

5-
# The pull request should have a useful title. Pull requests with `Update readme.md` as title will be closed right away because I'm so tired of nobody reading this document. Please carefully read everything in `Adding to this list`.
5+
## Adding a awesome list
66

7-
## Table of Contents
8-
9-
- [Adding to this list](#adding-to-this-list)
10-
- [Creating your own awesome list](#creating-your-own-awesome-list)
11-
- [Adding something to an awesome list](#adding-something-to-an-awesome-list)
12-
- [Updating your Pull Request](#updating-your-pull-request)
13-
14-
## Adding to this list
15-
16-
Please ensure your pull request adheres to the following guidelines:
17-
18-
- Search previous suggestions before making a new one, as yours may be a duplicate.
19-
- Make sure the list is useful before submitting. That implies it has enough content and every item has a good succinct description.
20-
- Make an individual pull request for each suggestion.
21-
- Use [title-casing](http://titlecase.com) (AP style).
22-
- Use the following format: `[List Name](https://github.com/user/repo#readme)` *(Note how `#readme` is appended to the link)*
23-
- Link additions should be added to the bottom of the relevant category.
24-
- New categories or improvements to the existing categorization are welcome.
25-
- Check your spelling and grammar.
26-
- Make sure your text editor is set to remove trailing whitespace.
27-
- The pull request and commit should have a useful title.
28-
- The body of your commit message should contain a link to the repository.
29-
30-
Thank you for your suggestions!
7+
Please ensure your pull request adheres to the [list guidelines](pull_request_template.md).
318

329
## Creating your own awesome list
3310

create-list.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Creating Your Own List
22

3-
- Read the [awesome manifesto](https://github.com/sindresorhus/awesome/blob/master/awesome.md) and ensure your list complies.
3+
- Read the [awesome manifesto](awesome.md) and ensure your list complies.
44
- Search this list before making a new one, as yours may be a duplicate. If it is, try and contribute to the best one instead of making your own.
5-
- Your awesome list should be named `awesome-list-name` and have the [awesome badge](https://github.com/sindresorhus/awesome/blob/master/awesome.md#awesome-badge), a [license](https://github.com/sindresorhus/awesome/blob/master/awesome.md#choose-an-appropriate-license), and [contribution guidelines](https://github.com/sindresorhus/awesome/blob/master/awesome.md#include-contribution-guidelines). Adding a [code of conduct](http://contributor-covenant.org/) is also strongly recommended. You might find [this Yeoman generator](https://github.com/dar5hak/generator-awesome-list) useful.
5+
- Your awesome list should be named `awesome-list-name` and have the [awesome badge](https://github.com/sindresorhus/awesome/blob/master/awesome.md#awesome-badge), a [license](awesome.md#choose-an-appropriate-license), and [contribution guidelines](awesome.md#include-contribution-guidelines). Adding a [code of conduct](http://contributor-covenant.org/) is also strongly recommended. You might find [this Yeoman generator](https://github.com/dar5hak/generator-awesome-list) useful.
66
- **Wait at least 30 days after creating a list before submitting it, to give it a chance to mature.**
7-
- Make sure you read the [contribution guidelines](https://github.com/sindresorhus/awesome/blob/master/contributing.md) before submitting a request for your list to be added here.
7+
- **Make sure you read the [list guidelines](pull_request_template.md) before submitting a pull request for your list to be added here.**
88

99
Thanks for being awesome!

pull_request_template.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,12 @@
1515

1616
## Requirements for your pull request
1717

18-
- 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).
19-
- This pull request has a descriptive title.<br>For example, `Add Name of List`, not `Update readme.md` or `Add awesome list`.
18+
- I have read and understood the [instructions for creating a list](https://github.com/sindresorhus/awesome/blob/master/create-list.md).
19+
- This pull request has a descriptive title in the format `Add Name of List` (Example: `Add Swift`), not `Update readme.md` or `Add awesome list`.
2020
- The entry in the Awesome list should:
2121
- 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.`.
2222
- Be added at the bottom of the appropriate category.
23-
- The list I'm submitting complies with these requirements:
23+
- The list I'm submitting complies with the below requirements.
2424

2525

2626
## Requirements for your Awesome list

0 commit comments

Comments
 (0)