Initial version of contributing.md

pull/252/head
JoranHonig 7 years ago committed by GitHub
parent 3fd3bfc4a5
commit 057107505e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 20
      CONTRIBUTING.md

@ -0,0 +1,20 @@
# Contributing to mythril
Hi, if you are reading this that means that you probably want to contribute to mythril, awesome!
If not, then this file might not contain much useful information for you.
## Creating an issue
If you have found a problem with mythril or want to propose a new feature then you can do this using GitHub issues.
We already created some templates to make this process easier, but if your issue/feature request does not fit within the template then feel free to deviate.
If you have a small question or aren't sure if you should create an issue for your problem/suggestion then you can always hop by on our gitter channel
[![Join the chat at https://gitter.im/ConsenSys/mythril](https://badges.gitter.im/ConsenSys/mythril.svg)](https://gitter.im/ConsenSys/mythril?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
# Coding
If you want to help out with the development of mythril then you can take a look at our issues or waffle board. [![Waffle.io - Columns and their card count](https://badge.waffle.io/ConsenSys/mythril.svg?columns=all)](https://waffle.io/ConsenSys/mythril)
Before you start working on an issue you should hop by on gitter to message a collaborator, this way we can assign you to the issue making sure nobody does double work.
We can also provide you with support through gitter if there are any questions during the development process.
## New ideas
Before you start working on a new idea, it's useful to create an issue on GitHub, that way we know what you want to implement and that you are working on it.
Additionally, it might happen that your feature does not fit with our roadmap, in which case it would be unfortunate if you have already spent some time working on it.
Loading…
Cancel
Save