Skip to content

Latest commit

 

History

History
42 lines (32 loc) · 2.32 KB

CONTRIBUTING.md

File metadata and controls

42 lines (32 loc) · 2.32 KB

Contributing to zkBob

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

We Develop with Github

We use github to host code, to track issues and feature requests, as well as accept pull requests. For any technical questions you can also use our Discord server

All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:

  1. Fork the repo and create your branch from main.
  2. If you've changed/added any features, update the documentation in the specific section.
  3. Ensure the test suite passes.
  4. Make sure your code lints.
  5. Issue that pull request!

Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same MIT License and Apache License that covers the project. Feel free to contact the maintainers if that's a concern.

Report bugs using Github's issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy! You can also report urgent bugs on our Discord server

Write bug reports with detail, background, and sample code

The issues with the bug report should be well-described. It should include at least the following sections:

  • Expected Behavior

  • Actual Behavior

  • Steps to reproduce

    • Be specific!

  • Any references regarding a bug (screenshots with errors, etc)

  • Your machine info (platform, what wallet do you use etc)

  • zkBob UI details: your support ID, Library, Web and Relayer versions. You can find this informatio at the buttom of the UI page

License

By contributing, you agree that your contributions will be licensed under its MIT License and Apache-2.0 Licence.