Skip to content

Latest commit

 

History

History
39 lines (25 loc) · 2.31 KB

CONTRIBUTING.md

File metadata and controls

39 lines (25 loc) · 2.31 KB
Raw

Contributing to Dynamic SSZ (dynssz)

First off, thank you for considering contributing to dynssz! It's people like you that make the open-source community such a fantastic place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.

What types of contributions are we looking for?

We are looking for contributions of all kinds: bug fixes, added features, documentation improvements, or even new specs to support more dynamic Ethereum scenarios. If you're looking to help out, take a look at the open issues for areas where you can contribute.

Ground Rules & Expectations

Before you contribute, please read through this document. By contributing to dynssz, you agree that your contributions will be licensed under its Apache license.

  • Ensure that your code adheres to the coding conventions used throughout the project. This includes using descriptive variable names, commenting your code where necessary, and following the existing coding style.
  • Before submitting a pull request, check for any errors or warnings.
  • Participate in code reviews and respond to feedback in a timely manner.
  • If you're adding new functionality, provide tests that cover the new code and ensure it integrates well with the existing library.
  • Update the README.md with details of changes to the interface, including new environment variables, exposed ports, useful file locations, and container parameters.

How to contribute?

If you're ready to contribute, here's how you can do it:

  1. Fork the repository.
  2. Clone your forked repository to your local machine.
  3. Create a new branch for your changes.
  4. Make your changes and commit them with clear, descriptive commit messages.
  5. Push your changes to your fork.
  6. Submit a pull request from your fork back to the main dynssz repository.
  7. Wait for feedback or approval from the project maintainers.

Reporting Issues

If you find a bug or have a feature request, please use the GitHub issue tracker to report this. Before creating a new issue, do a quick search to see if the problem has been reported already. If it has, add a comment to the existing issue instead of opening a new one.

License

By contributing to dynssz, you agree that your contributions will be licensed under its Apache license.

Thank you for contributing to dynssz!