Skip to content

Latest commit

聽

History

History
54 lines (29 loc) 路 1.34 KB

CONTRIBUTING.md

File metadata and controls

54 lines (29 loc) 路 1.34 KB
Raw

Contributing Guidelines

The 馃寠 HelmWave project accepts contributions via GitHub pull requests.
This document outlines the process to help get your contribution accepted.

Milestones

We use milestones to track the progress of specific planned releases.

Versioning

We use semver

Developing flow

fix/feature-branch --> release-$SEMVER --> main

Example:

  • my-feature --> release/0.17.0 --> main
  • my-fix --> release/0.17.1 --> main

Non product update

When don't affect any *.go files we use githubFlow.

some branch --> main

Documentation update

After merging new release branch (minor or major) a new branch and PR in helmwave/docs will be created automatically. You will need to update documentation (if necessary) and merge this PR into main branch.

How to build?

https://helmwave.github.io/docs/0.17.x/install/#compile-from-source

Pre commit

We use https://pre-commit.com for git hooks

How to upgrade golang version?

change a version in next files:

  1. go.mod
  2. Dockerfile: GOLANG_VERSION=1.21
  3. ci

How to upgrade alpine version?

change a version in next files:

  1. Dockerfile: ALPINE_VERSION=3.18