mirror of
https://github.com/enaqx/awesome-pentest.git
synced 2024-12-23 06:09:22 -05:00
Update CONTRIBUTING.md
This commit is contained in:
parent
09bf297601
commit
7a26aa0ee4
7
.github/CONTRIBUTING.md
vendored
7
.github/CONTRIBUTING.md
vendored
@ -10,10 +10,11 @@
|
|||||||
Please ensure your pull request adheres to the following guidelines:
|
Please ensure your pull request adheres to the following guidelines:
|
||||||
|
|
||||||
- Search previous suggestions before making a new one, as yours may be a duplicate.
|
- Search previous suggestions before making a new one, as yours may be a duplicate.
|
||||||
- Make sure the list is useful before submitting. That implies it has enough content and every item has a good succinct description.
|
- Make sure the submission is useful before submitting.
|
||||||
- Make an individual pull request for each suggestion.
|
- Make an individual pull request for each suggestion.
|
||||||
- Use [title-casing](http://titlecapitalization.com) (AP style).
|
- Use [title-casing](http://titlecapitalization.com) (AP style).
|
||||||
- Use the following format: `[List Name](link)`
|
- Use the following format: `[List Name](link) - Optional Description`.
|
||||||
|
- Optional descriptions are useful when the name itself is not descriptive.
|
||||||
- Link additions should be added to the bottom of the relevant category.
|
- Link additions should be added to the bottom of the relevant category.
|
||||||
- New categories or improvements to the existing categorization are welcome.
|
- New categories or improvements to the existing categorization are welcome.
|
||||||
- Check your spelling and grammar.
|
- Check your spelling and grammar.
|
||||||
@ -23,6 +24,6 @@ Please ensure your pull request adheres to the following guidelines:
|
|||||||
|
|
||||||
## Updating your Pull Request
|
## Updating your Pull Request
|
||||||
|
|
||||||
Sometimes, a maintainer of an awesome list will ask you to edit your Pull Request before it is included. This is normally due to spelling errors or because your PR didn't match the awesome-* list guidelines.
|
Sometimes, a maintainer of an awesome list will ask you to edit your Pull Request before it is included. This is normally due to spelling errors or because your PR didn't make any useful addition.
|
||||||
|
|
||||||
[Here](https://github.com/RichardLitt/docs/blob/master/amending-a-commit-guide.md) is a write up on how to change a Pull Request, and the different ways you can do that.
|
[Here](https://github.com/RichardLitt/docs/blob/master/amending-a-commit-guide.md) is a write up on how to change a Pull Request, and the different ways you can do that.
|
||||||
|
Loading…
Reference in New Issue
Block a user