CONTRIBUTING.md

How to contribute to OmiseGO's projects

Welcome to one of OmiseGO's open source projects! We welcome contributions of all kinds and shapes: code, documentation, bug reports, and feedback... But before opening your first issue or PR, please read through this document.

Did you find a bug?

• Do not create issues for security vulnerabilities. We are currently setting up a bounty program for these. In the meantime, you can get in touch with us via email.
• For other bugs, first ensure that the bug you have found has not been reported yet. To do so, you can search under issues.
• Open a new issue if you didn't find an existing one. Follow the issue template and be as specific as possible.

Did you write a patch that fixes a bug?

• Open a Pull Request.
• Describe the problem and solution. Add a link to the issue if any.
• Read the coding conventions.

In order for the build to pass, the following commands must run successfully without errors:

• mix format --check-formatted
• mix credo
• mix dialyzer
• mix test

Do you intend to add a new feature or change an existing one?

• Do not open an issue right away. First, get in touch with us through Gitter. Once you get the green light to work on something, create an issue to describe the whole idea.

Do you have questions about the source code?

• You can ask any questions about the source code on Gitter or on stack overflow.

Thanks!

The OmiseGO Team