awesome-malware-analysis/CONTRIBUTING.md

37 lines
1.3 KiB
Markdown
Raw Normal View History

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