mirror of
https://github.com/enaqx/awesome-pentest.git
synced 2024-10-01 01:05:56 -04:00
b40bbe3963
This commit is a first-pass attempt at adhering to the style guide of the Awesome List contribution guidelines at https://github.com/sindresorhus/awesome/blob/master/pull_request_template.md Specificaly, I have: * added a succinct description of the project/theme at top of README. * added the awesome badge on the right side of the list heading. * titled the table of contents `Contents`. * moved the `CONTRIBUTING.md` file to the expected filesystem path. * capitalized the first word of link descriptions, when present. * added trailing periods to link descriptions, when not present. * removed the "A" and "An" prepositions from link descriptions. * removed the Travis CI build status badge. * matched the heading levels to the style guide's recommendations.
46 lines
2.9 KiB
Markdown
46 lines
2.9 KiB
Markdown
# Contribution Guidelines
|
|
|
|
**Your pull request should have a useful title. Please carefully read everything in [Adding to this list](#adding-to-this-list).**
|
|
|
|
## Table of Contents
|
|
|
|
- [Adding to this list](#adding-to-this-list)
|
|
- [Creating your own awesome list](#creating-your-own-awesome-list)
|
|
- [Adding something to an awesome list](#adding-something-to-an-awesome-list)
|
|
- [Updating your Pull Request](#updating-your-pull-request)
|
|
|
|
## 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 item you are adding is useful (and, you know, awesome) before submitting.
|
|
- Make an individual pull request for each suggestion.
|
|
- Use [title-casing](http://titlecapitalization.com) (AP style).
|
|
- Use the following format: `[Item Name](link)`
|
|
- 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.
|
|
|
|
Thank you for your suggestions!
|
|
|
|
## Adding something to an awesome list
|
|
|
|
If you have something awesome to contribute to an awesome list, this is how you do it.
|
|
|
|
You'll need a [GitHub account](https://github.com/join)!
|
|
|
|
1. Access the awesome list's GitHub page. For example: https://github.com/sindresorhus/awesome
|
|
2. Click on the `readme.md` file: 
|
|
3. Now click on the edit icon. 
|
|
4. You can start editing the text of the file in the in-browser editor. Make sure you follow guidelines above. You can use [GitHub Flavored Markdown](https://help.github.com/articles/github-flavored-markdown/). 
|
|
5. Say why you're proposing the changes, and then click on "Propose file change". 
|
|
6. Submit the [pull request](https://help.github.com/articles/using-pull-requests/)!
|
|
|
|
## Updating your Pull Request
|
|
|
|
Sometimes, a maintainer of this 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. [Here is a write up on how to change a Pull Request](https://github.com/RichardLitt/docs/blob/master/amending-a-commit-guide.md), and the different ways you can do that.
|