Skip to content

Latest commit

 

History

History
52 lines (33 loc) · 2.64 KB

CONTRIBUTING.md

File metadata and controls

52 lines (33 loc) · 2.64 KB

Contributing to livepeer-exporter

Your contributions mean the world to us! 🚀 We aim to keep the process transparent and straightforward, whether you're:

We Develop with Github

GitHub is our playground—we use it to host code, track issues, and accept pull requests.

Follow Github Flow for a Seamless Experience

We stick to Github Flow, ensuring that all code changes happen through pull requests. Here's a simple guide:

  1. Fork the repo and create your branch from main.
  2. Add tests if your code introduces new functionalities.
  3. If you tweak APIs, make sure to update the documentation.
  4. Confirm that the test suite passes.
  5. Ensure your code follows our style guidelines.
  6. Build the node package using the go build command.
  7. Issue that pull request!

Your Contributions, Your License

Any contributions you make fall under the MIT Software License. Your submissions are covered by the same MIT License that protects the project. If you have concerns, reach out to the maintainers—they're here for you.

Report Bugs via Github's issues

Help us keep track of bugs by opening a new issue; it's a breeze!

Craft Bug Reports with Detail and Love

Take a cue from these examples for crafting top-notch bug reports. Great bug reports have:

  • A quick summary and background.
  • Clear steps to reproduce, including sample code if possible.
  • Your expectations vs. reality.
  • Any notes, experiments, or thoughts on the issue.

Thorough bug reports warm our hearts. Seriously!

Embrace a Consistent Coding Style

Our Golang code follows the gofmt formatter. Easily maintain the style with the golang.Go VS Code extension.

References

This contribution guide is adapted from the open-source guidelines for Facebook's Draft.