forked from unicodeveloper/awesome-nextjs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
23 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# Contribution Guidelines | ||
|
||
Ensure your pull request adheres to the following guidelines: | ||
|
||
- Search previous suggestions before making a new one, as yours may be a duplicate. | ||
- Make an individual pull request for each suggestion. | ||
- Use [title-casing](http://titlecapitalization.com) (AP style). | ||
- Use the following format: `[Title Case Name](link) - Description.` | ||
> :information_source: [Articles](https://github.com/unicodeveloper/awesome-nextjs#articles) should use the `[Title Case Name](link)` format. | ||
- Keep descriptions short and simple, but descriptive. | ||
- Start the description with a capital and end with a full stop/period. | ||
> :information_source: You can use an emoji, only before the Title-Cased Description. | ||
- Check your spelling and grammar. | ||
- Make sure your text editor is set to remove trailing whitespace. | ||
- New categories or improvements to the existing categorization are welcome. | ||
- Pull requests should have a useful title. | ||
- The body of your commit message should contain a link to the repository. | ||
|
||
Thank you for your suggestion! | ||
|
||
### Updating your PR | ||
|
||
A lot of times, making a PR adhere to the standards above can be difficult. If the maintainers notice anything that we'd like changed, we'll ask you to edit your PR before we merge it. There's no need to open a new PR, just edit the existing one. If you're not sure how to do that, [here is a guide](https://github.com/RichardLitt/docs/blob/master/amending-a-commit-guide.md) on the different ways you can update your PR so that we can merge it. |