|
| 1 | +# Contributing to Echidna |
| 2 | + |
| 3 | +First, thanks for your interest in contributing to Echidna! We welcome and |
| 4 | +appreciate all contributions, including bug reports, feature suggestions, |
| 5 | +tutorials/blog posts, and code improvements. |
| 6 | + |
| 7 | +If you're unsure where to start, we recommend to join our [chat room](https://empireslacking.herokuapp.com/) |
| 8 | +(in the #ethereum channel) to discuss new ideas to improve this tool. You can also take a look to the [`help wanted`](https://github.com/crytic/echidna/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) |
| 9 | +issue labels. |
| 10 | + |
| 11 | +## Bug reports and feature suggestions |
| 12 | + |
| 13 | +Bug reports and feature suggestions can be submitted to our [issue |
| 14 | +tracker](https://github.com/crytic/echidna/issues). For bug reports, |
| 15 | +attaching the contract that caused the bug will help us in debugging and |
| 16 | +resolving the issue quickly. If you find a security |
| 17 | +vulnerability, do not open an issue; email `opensource@trailofbits.com` |
| 18 | +instead. |
| 19 | + |
| 20 | +## Questions |
| 21 | + |
| 22 | +Questions can be submitted to the issue tracker, but you may get a faster |
| 23 | +response if you ask in our [chat room](https://empireslacking.herokuapp.com/) |
| 24 | +(in the #ethereum channel). |
| 25 | + |
| 26 | +## Code |
| 27 | + |
| 28 | +Echidna uses the pull request contribution model. Please make an account on |
| 29 | +Github, fork this repo, and submit code contributions via pull request. For |
| 30 | +more documentation, look [here](https://guides.github.com/activities/forking/). |
| 31 | + |
| 32 | +Some pull request guidelines: |
| 33 | + |
| 34 | +- Minimize irrelevant changes (formatting, whitespace, etc) to code that would |
| 35 | + otherwise not be touched by this patch. Save formatting or style corrections |
| 36 | + for a separate pull request that does not make any semantic changes. |
| 37 | +- When possible, large changes should be split up into smaller focused pull |
| 38 | + requests. |
| 39 | +- Fill out the pull request description with a summary of what your patch does, |
| 40 | + key changes that have been made, and any further points of discussion, if |
| 41 | + applicable. |
| 42 | +- Title your pull request with a brief description of what it's changing. |
| 43 | + "Fixes #123" is a good comment to add to the description, but makes for an |
| 44 | + unclear title on its own. |
| 45 | +- We use a "CodeClimate" verification check in every PR to make sure the code merged |
| 46 | + is tidy and easy to understand. |
0 commit comments