Awesome-Mirrors/awesome-pentest
1
0
Fork 0
mirror of https://github.com/enaqx/awesome-pentest.git synced 2024-10-01 01:05:56 -04:00
Code Issues Packages Projects Releases Wiki Activity
3bf62af601
awesome-pentest/.github/CONTRIBUTING.md
Samar Dhwoj Acharya 7a26aa0ee4 Update CONTRIBUTING.md
2016-03-13 11:43:10 -05:00

1.4 KiB
Raw Blame History

Contribution Guidelines

Table of Contents

Adding to this list

Please ensure your pull request adheres to the following guidelines:

  • Search previous suggestions before making a new one, as yours may be a duplicate.
  • Make sure the submission is useful before submitting.
  • Make an individual pull request for each suggestion.
  • Use title-casing (AP style).
  • 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.
  • New categories or improvements to the existing categorization are welcome.
  • Check your spelling and grammar.
  • Make sure your text editor is set to remove trailing whitespace.
  • The pull request and commit should have a useful title.
  • The body of your commit message should contain a link to the repository.

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 make any useful addition.

Here is a write up on how to change a Pull Request, and the different ways you can do that.