-
Notifications
You must be signed in to change notification settings - Fork 128
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
1 parent
534b760
commit 232fa2d
Showing
3 changed files
with
36 additions
and
14 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,8 @@ | ||
root = true | ||
|
||
[*] | ||
indent_style = tab | ||
end_of_line = lf | ||
charset = utf-8 | ||
trim_trailing_whitespace = true | ||
insert_final_newline = true |
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
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 |
---|---|---|
@@ -1,19 +1,33 @@ | ||
# Contribution Guidelines | ||
|
||
Please ensure your pull request adheres to the following: | ||
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. | ||
|
||
- Search previous suggestions before making a new one to ensure yours is not a duplicate. | ||
--- | ||
|
||
Ensure your pull request adheres to the following guidelines: | ||
|
||
- Search previous suggestions before making a new one, as yours may be a duplicate. | ||
- Don't open a Draft / WIP pull request while you work on the guidelines. A pull request should be 100% ready and should adhere to all the guidelines when you open it. | ||
- Make an individual pull request for each suggestion. | ||
- Use the following format: \[NAME\]\(LINK\) - DESCRIPTION. | ||
- Keep descriptions simple. | ||
- New categories, or improvements to the existing ones are welcome. | ||
- End all descriptions with a period. | ||
- The pull request title should be in the following format: `Add Project Name` | ||
- `Add` not `add` | ||
- The suggestion should be in English. | ||
- Use the following format: `[Title](link) - Description.` | ||
- Additions should be added to the bottom of the relevant category. | ||
- If the submitted project is an open-source project on GitHub: | ||
- It should have at least 20 stars. | ||
- Link to the GitHub repo, not its website. | ||
- Keep descriptions short and simple, but descriptive. | ||
- The description should not be a marketing tagline. | ||
- The description should not be title-case. | ||
- The description should not repeat the item title. | ||
- The description should start with a capital and end with a full stop/period. | ||
- Check your spelling and grammar. | ||
- Make sure your text editor is set to remove trailing whitespace. | ||
- Try to ensure your pull requests only have one commit if possible. You can squash your commits into one before submitting. | ||
- Make your pull request titles and descriptions as detailed as possible. Explain why an asset or resources deserves to be added to the list. | ||
- Make sure your additions are in alphabetical order. This includes the headers and items themselves. | ||
- Ensure that assets you submit are of high quality, documented well, and are recently maintained. It also helps if they're popular so I can research them before adding them to the list. | ||
- This is not meant to be used as a list to advertise your own assets. Free or open-source assets should be prioritized over paid assets if they are of similar quality and feature sets. | ||
- run https://github.com/sindresorhus/awesome-lint before submitting | ||
- New categories or improvements to the existing categorization are welcome, but should be done in a separate pull request. | ||
|
||
Thank you for your suggestion! | ||
|
||
## Updating your PR | ||
|
||
Thanks! | ||
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. If you're not sure how to do that, [here is a guide](https://github.com/RichardLitt/knowledge/blob/master/github/amending-a-commit-guide.md) on the different ways you can update your PR so that we can merge it. |