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
f292ec467e
awesome-pentest/CONTRIBUTING.md

47 lines
2.7 KiB
Markdown
Raw Normal View History

First round of making this list awesome compliant, for #86. 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.
2017-07-06 00:29:02 -04:00
# 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
Various updates
2017-12-11 01:24:25 -05:00
* [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)
First round of making this list awesome compliant, for #86. 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.
2017-07-06 00:29:02 -04:00
## Adding to this list
Please ensure your pull request adheres to the following guidelines:
Various updates
2017-12-11 01:24:25 -05:00
* 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.
First round of making this list awesome compliant, for #86. 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.
2017-07-06 00:29:02 -04:00
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: ![Step 2 Click on Readme.md](https://cloud.githubusercontent.com/assets/170270/9402920/53a7e3ea-480c-11e5-9d81-aecf64be55eb.png)
3. Now click on the edit icon. ![Step 3 - Click on Edit](https://cloud.githubusercontent.com/assets/170270/9402927/6506af22-480c-11e5-8c18-7ea823530099.png)
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/). ![Step 4 - Edit the file](https://cloud.githubusercontent.com/assets/170270/9402932/7301c3a0-480c-11e5-81f5-7e343b71674f.png)
5. Say why you're proposing the changes, and then click on "Propose file change". ![Step 5 - Propose Changes](https://cloud.githubusercontent.com/assets/170270/9402937/7dd0652a-480c-11e5-9138-bd14244593d5.png)
6. Submit the [pull request](https://help.github.com/articles/using-pull-requests/)!
## Updating your Pull Request
Various updates
2017-12-11 01:24:25 -05:00
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.
Reference in New Issue Copy Permalink