Help is always appreciated!
To get started, you can try building-from-source in order to familiarize yourself with the components of Viper and the build process. Also, it may be useful to become well-versed at writing smart-contracts in Viper.
Types of Contributions¶
In particular, we need help in the following areas:
How to Report Issues¶
To report an issue, please use the GitHub issues tracker. When reporting issues, please mention the following details:
- Which version of Viper you are using
- What was the source code (if applicable)
- Which platform are you running on
- Your operating system name and version
- Detailed steps to reproduce the issue
- What was the result of the issue
- What the expected behaviour is
Reducing the source code that caused the issue to a bare minimum is always very helpful and sometimes even clarifies a misunderstanding.
Workflow for Pull Requests¶
In order to contribute, please fork off of the
master branch and make your
changes there. Your commit messages should detail why you made your change
in addition to what you did (unless it is a tiny change).
If you need to pull in any changes from
master after making your fork (for
example, to resolve potential merge conflicts), please avoid using
git rebase your branch.
Additionally, if you are writing a new feature, please ensure you write appropriate
Boost test cases and place them under
However, if you are making a larger change, please consult with the Gitter channel, first.
Also, even though we do CI testing, please make sure that the tests pass for supported Python version and ensure that it builds locally before submitting a pull request.
Thank you for your help!