Make the contributing guidelines for fluent-operator chart more visible#603
Make the contributing guidelines for fluent-operator chart more visible#603marcofranssen wants to merge 6 commits intofluent:mainfrom
Conversation
marcofranssen
force-pushed
the
contributing-improvements
branch
4 times, most recently
from
6f717da to
06c4718
Compare
marcofranssen
force-pushed
the
contributing-improvements
branch
from
06c4718 to
7e4f0a3
Compare
stevehipwell
requested review from
patrick-stephens and
stevehipwell
as code owners
|
Please can you rebase on the latest versions and resolve any conflicts so we can bring in the updated CI? |
marcofranssen
force-pushed
the
contributing-improvements
branch
from
7e4f0a3 to
9496bf1
Compare
|
@patrick-stephens done, please make suggstions on what to remove/reword etc. |
|
Looks like just some markdown linting to sort |
Signed-off-by: Marco Franssen <marco.franssen@gmail.com>
marcofranssen
force-pushed
the
contributing-improvements
branch
from
9496bf1 to
b605b97
Compare
|
@stevehipwell I'll let you review this one as you've been reworking things a bit in this area. |
stevehipwell
left a comment
stevehipwell
left a comment
There was a problem hiding this comment.
I've added some comments, but in general this looks just appended to the existing docs rather than being part of them.
CONTRIBUTING.md
Outdated
| ### Immutability | ||
|
|
||
| Chart releases must be immutable. Any change to a chart warrants a chart version bump even if it is only changed to the documentation. |
There was a problem hiding this comment.
This is no longer relevant, chart releases should be managed by the maintainers. Chart contributions should be accumulated without modifying the chart version, unless explicitly requested by a maintainer.
CONTRIBUTING.md
Outdated
|
|
||
| The chart `version` should follow [semver](https://semver.org/). | ||
|
|
||
| Charts should start at `1.0.0`. Any breaking (backwards incompatible) changes to a chart should: |
There was a problem hiding this comment.
New charts should initially be added with 0.0.x or 0.x.yversions, with the eventual aim to hitv1.0.0. It may be useful to release 1.0.0-beta.xor1.0.0-rc.x` versions.
Existing charts may want to use x.0.0-beta.y or x.y.0-rc.z versions.
Signed-off-by: Marco Franssen <marco.franssen@gmail.com>
Signed-off-by: Marco Franssen <marco.franssen@gmail.com>
Signed-off-by: Marco Franssen <marco.franssen@gmail.com>
Signed-off-by: Marco Franssen <marco.franssen@gmail.com>
| ### Technical Requirements | ||
|
|
||
| - Must pass [DCO check](#sign-off-your-work) | ||
| - Must follow [Charts best practices](https://helm.sh/docs/topics/chart_best_practices/) | ||
| - Must pass CI jobs for linting and installing changed charts with the [chart-testing](https://github.com/helm/chart-testing) tool | ||
| - Any change to a chart requires a version bump following [semver](https://semver.org/) principles. | ||
|
|
||
| Once changes have been merged, the release job will automatically run to package and release changed charts. | ||
|
|
||
| ### Community Requirements | ||
|
|
||
| This project is released with a [Contributor Covenant](https://www.contributor-covenant.org). | ||
| By participating in this project you agree to abide by its terms. | ||
| See [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md). |
There was a problem hiding this comment.
Anything in here that's missing from the sections above could be added there.
Co-authored-by: Steve Hipwell <steve.hipwell@gmail.com> Signed-off-by: Marco Franssen <marco.franssen@gmail.com>
3 participants
Also added a header so we can refer to it in all the fluent-operator PRs to inform people.