Github
/
awesome-chatgpt
mirror of
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve contribution guidelines

This commit is contained in:
Sindre Sorhus 2023-05-12 20:26:29 +07:00
parent 57efe74404
commit b589353b32
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
contributing.md
View File

@ -6,10 +6,11 @@ Please note that this project is released with a [Contributor Code of Conduct](c
Ensure your pull request adheres to the following guidelines:
- 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.
- 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.
- 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.
@ -17,13 +18,12 @@ Ensure your pull request adheres to the following guidelines:
- 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 marketing taglines.
- 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.
- 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. You can use ChatGPT for this!
- Make sure your text editor is set to remove trailing whitespace.
- The pull request should have a useful title.
- New categories or improvements to the existing categorization are welcome, but should be done in a separate pull request.
Thank you for your suggestion!