Create CONTRIBUTING.md (#481)

* Create CONTRIBUTING.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md
2017-09-06 18:11:22 -04:00
parent 7679773088
commit d83fa737a7
1 changed files with 43 additions and 0 deletions
@@ -0,0 +1,43 @@
+# Contributing to Manticore
+
+First, thanks for your interest in contributing to Manticore! We welcome and
+appreciate all contributions, including bug reports, feature suggestions,
+tutorials/blog posts, and code improvements.
+
+If you're unsure where to start, we recommend our [`easy`](https://github.com/trailofbits/manticore/issues?q=is%3Aissue+is%3Aopen+label%3Aeasy) and [`help wanted`](https://github.com/trailofbits/manticore/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)
+issue labels.
+
+## Bug reports and feature suggestions
+
+All of these can be submitted to our [issue
+tracker](https://github.com/trailofbits/manticore/issues).  If you find a
+security vulnerability, do not open an issue; email opensource@trailofbits.com
+instead.
+
+## Questions
+
+Questions can be submitted to the issue tracker, but you may get a faster
+response if you ask in our [chat room](https://empireslacking.herokuapp.com/)
+(in the #manticore channel).
+
+## Code
+
+Manticore uses the pull request contribution model. Please make an account on
+github, fork this repo, and submit code contributions via pull request. For
+more documentation, look [here](https://guides.github.com/activities/forking/).
+
+Some pull request guidelines:
+
+- Minimize irrelevant changes (formatting, whitespace, etc) to code that would
+  otherwise not be touched by this patch. Save formatting or style corrections
+  for a separate pull request that does not make any semantic changes.
+- When possible, large changes should be split up into smaller focused pull
+  requests.
+- Fill out the pull request description with a summary of what your patch does,
+  key changes that have been made, and any further points of discussion, if
+  applicable.
+
+### Development Environment
+
+Instructions for installing a development version of Manticore can be found in
+our [wiki](https://github.com/trailofbits/manticore/wiki/Hacking-on-Manticore#developer-installation).