Skip to content

Latest commit

 

History

History
59 lines (42 loc) · 2.82 KB

CONTRIBUTING.md

File metadata and controls

59 lines (42 loc) · 2.82 KB
Raw

Contributing to the Ribbit Network

We love your input! It’s people like you that make this project a reality.

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
  • Improving documentation
  • Adding new relevant research
  • Anything else you can think of!

How to contribute

The information below helps to explain the mechanics of how to contribute to Ribbit Network, but don't be afraid or shy!

If you are confused, need help, or want to discuss an idea you can find our team here:

Remember to be nice and polite. We're all on this planet together and we're working to change it for the better :)

We Develop with Github

We use github to host code, to track issues and feature requests, as well as accept pull requests.

We Use Github Flow, So All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests:

  1. Fork the repository to your own Github account
  2. Clone the project to your machine
  3. Create a branch locally with a succinct but descriptive name
  4. Commit changes to the branch
  5. Following any formatting and testing guidelines specific to this repo
  6. Push changes to your fork
  7. Open a PR in our repository and follow the PR template so that we can efficiently review the changes.

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 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!

Write bug reports with detail, background, pictures or sample code if relevant

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code or pictures of details if you can.
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

We love thorough bug reports. Not kidding, it's reports like this that make this project better!

License

By contributing, you agree that your contributions will be licensed under its MIT License.