Skip to content

Latest commit

 

History

History
55 lines (33 loc) · 2.69 KB

CONTRIBUTING.md

File metadata and controls

55 lines (33 loc) · 2.69 KB

Contributing to StreamETH

First off, thank you for considering contributing to StreamETH. It's people like you that make StreamETH such a great tool.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.

Quick Links

Code of Conduct

This project and everyone participating in it is governed by the StreamETH Code of Conduct. By participating, you are expected to uphold this code.

Found a Bug?

If you find a bug in the source code, you can help us by submitting an issue to our GitHub Repository. Even better, you can submit a Pull Request with a fix.

Missing a Feature?

You can request a new feature by submitting an issue to our GitHub Repository. If you would like to implement a new feature, please submit an issue with a proposal for your work first, to be sure that it is of interest to the project. After discussion, you may then start to work on a Pull Request.

Pull Request Process

  1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  2. Give a concise Pull Request on what you build.
  3. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations, and container parameters.
  4. The Pull Request will be merged once it has the sign-off of two core developers, or if it's a trivial change, it may be merged by a single core developer.

Getting Started

Please check out our documentation for getting set up with development.

Coding Standards

Please follow the coding standards and guidelines described in our developer documentation.

Making Trivial Changes

For something that is bigger than a one or two-line fix:

  1. Create your own fork of the code
  2. Do the changes in your fork
  3. If you like the change and think the project could use it:
    • Be sure you have followed the code style for the project.
    • Send a pull request.

Final Notes

Remember that contributions to this repository can be made in many forms. There's much more to a successful project than just code. You can contribute by providing feedback on issues, suggesting enhancements, improving documentation, and a plethora of other ways. Whatever form your contributions take, we are grateful for them.

Happy coding!