The Nethermind infrastructure team is responsible for maintaining the Nethermind Helm charts. We welcome contributions from the community and are happy to review and merge pull requests. This document outlines the process for contributing to the Nethermind Helm charts.
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
- Create a new branch from
main. - Make changes to a single chart in the
charts/directory only (CI will fail if you try to update more than one chart). - Update the chart version in the
Chart.yamlfile, along with any other changes you want to make. Mind the semantic versioning rules. - Run
make docsto update theREADME.mdfile using thehelm-docstool. - Run
make lintto lint the chart. - Push your changes and create a pull request. The pull request should include a description of the changes made and the reason for the changes. The pull request title must follow the
[<chart-name>] <short-description>format. - The pull request will be reviewed by the maintainers. If the pull request is approved, it will be merged into the
mainbranch and new chart version will be released with tag<chart-name>-<chart-version>.
Branch names must follow kebab-case pattern. Follow the pattern feature/<name> or fix/<name> (folder/<name>) when it is possible and add issue reference if applicable.
Commits must follow the <type>(<scope>): <subject> pattern, as stated in the Conventional Commits specification. The scope should be the chart name.
The following is the list of types that can be used:
feat:for new featuresfix:for bugfixesimprovement:for enhancementsdocs:for documentation and examplesrefactor:for code refactoringtest:for testsci:for CI purposechore:for chores stuff