ch0ic3/awesome-malware-analysis
1
0
Fork 0
mirror of https://github.com/rshipp/awesome-malware-analysis.git synced 2024-12-18 18:26:09 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add to contributing guidelines

Browse Source
This commit is contained in:
rshipp 2016-05-26 13:33:32 -06:00
parent 5f4dfb2625
commit 710bf98fcf
No known key found for this signature in database
GPG Key ID: 1F4037ED24A4D1F0
1 changed files with 18 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
CONTRIBUTING.md
View File

@ -2,21 +2,35 @@
When making a pull request, please follow these guidelines: When making a pull request, please follow these guidelines:
- One commit per suggestion - One commit per suggestion is preferred
- Commit message should follow this format: `Add some tool name` - Commit message should follow this format: `Add some tool name` (For
example, `Add cuckoo-sandbox`) [Why?](http://chris.beams.io/posts/git-commit/)
- Multiple commits per pull request is OK - Multiple commits per pull request is OK
- Lists within each section are alphabetized - Lists within each section are alphabetized, please keep them that way
- Add sections if necessary, use existing sections if possible - Add sections if necessary, use existing sections if possible
- Clear, concise descriptions for each link, followed by a period - Clear, concise descriptions for each link, starting with a capital, ending
with a period
- Use the following format: `[Item Name](homepage link) - Description.` - Use the following format: `[Item Name](homepage link) - Description.`
- No duplication of tools, put them where they make the most sense - No duplication of tools, put them where they make the most sense
- Wrap lines at ~80 chars, no trailing whitespace or unnecessary newlines - Wrap lines at ~80 chars, no trailing whitespace or unnecessary newlines
- Prefer quality over quantity, only submit awesome stuff - Prefer quality over quantity, only submit awesome stuff
- By submitting a pull request, you agree to release your submission under - By submitting a pull request, you agree to release your submission under
the [LICENSE](LICENSE) the [LICENSE](LICENSE)
- Indent wrapped lines even with the start of the line before
```
- That means lines wrap like
this
- Not
like this
```
The rules above take precedence, but in case I missed something, check [the The rules above take precedence, but in case I missed something, check [the
awesome guidelines](https://github.com/sindresorhus/awesome/blob/master/contributing.md) awesome guidelines](https://github.com/sindresorhus/awesome/blob/master/contributing.md)
too. too.
Properly formatted pull requests will almost always be approved faster than
issues or poorly formatted pull requests, because they mean less work for me!
Thanks! Thanks!