-
Notifications
You must be signed in to change notification settings - Fork 495
Make the contributing guidelines for fluent-operator chart more visible #603
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
marcofranssen
wants to merge
6
commits into
fluent:main
Choose a base branch
from
marcofranssen:contributing-improvements
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
b605b97
Make the contributing guidelines for fluent-operator chart more visible
marcofranssen 097ed70
Apply suggestion from @marcofranssen
marcofranssen 5ebc224
Apply suggestion from @marcofranssen
marcofranssen e6b982f
Apply suggestion from @marcofranssen
marcofranssen c98cebb
Apply suggestion from @marcofranssen
marcofranssen cf82829
Apply suggestions from code review
marcofranssen File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -48,3 +48,34 @@ | |
| license and agrees to a Developer Certificate of Origin (see | ||
| http://developercertificate.org/ for more information). | ||
| ``` | ||
|
|
||
| ## How to Contribute | ||
|
|
||
| 1. Fork this repository, develop, and test your changes | ||
| 2. Remember to sign off your commits as described above | ||
| 3. Submit a pull request | ||
|
|
||
| > [!Note] | ||
| > In order to make testing and merging of PRs easier, please submit changes to multiple charts in separate PRs. | ||
|
|
||
| ### Fluent Operator Chart | ||
|
|
||
| > [!Important] | ||
| > The fluent-operator Chart is maintained in [this repository][fluent-operator-chart]. Please **do NOT submit PRs** for the fluent-operator Chart in this repository! Do all contributions in the [fluent-operator repository][fluent-operator-chart]. | ||
|
marcofranssen marked this conversation as resolved.
Outdated
|
||
|
|
||
| ### 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. See [Immutability(#immutability) and [Versioning](#versioning) below | ||
|
marcofranssen marked this conversation as resolved.
Outdated
|
||
|
|
||
| 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). | ||
|
Comment on lines
+59
to
+72
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Anything in here that's missing from the sections above could be added there. |
||
|
|
||
| [fluent-operator-chart]: https://github.com/fluent/fluent-operator/tree/master/charts/fluent-operator "Sources for the fluent-operator Chart" | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.