The Nethermind team maintains guidelines for contributing to the Nethermind repos. Check out our docs page if you want to learn more about us.
Also, give a read to our code of conduct if you haven't already.
Before you make your changes, check to see if an issue exists already for the change you want to make.
If you spot something new or want to change something, please make sure there isn't already an issue related to it.
If no issue addresses your problem, please open a new one with an accurate description of the problem. Please add, if possible, labels to have an overview of what they are targetting, and having an easier time filtering them out.
When you're done making changes and you'd like to propose them for review through a Pull Request. Please make sure the PR mentions the related issue, detailing the changes made and potential side effects.
If your PR is not ready for review and merge because you are still working on it, please convert it to a draft.
Please do:
- DO give priority to the current style of the project or file you're changing even if it diverges from the general guidelines.
- DO include tests when adding new features. When fixing bugs, start with adding a test that highlights how the current behavior is broken.
Please do not:
- DON'T copy paste code from other Virtual Machine implementations without a good argument to back it up.
- DON'T surprise us with big pull requests. Instead, file an issue and start a discussion so we can agree on a direction before you invest a large amount of time.
Please name your branch using the kebab-case pattern and use common sense to name it, so that its purpose remains clear. For example, if introduces a new feature that adds the allocation hint: feature-alloc-hint.