new(docs): dedicated rules contributing guide -> rules maturity definitions and rules acceptance criteria #115
Conversation
This file contains 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
Based on the proposal https://github.com/falcosecurity/rules/blob/main/proposals/20230605-rules-adoption-management-maturity-framework.md Signed-off-by: Melissa Kilby <[email protected]>
…k and adoption Signed-off-by: Melissa Kilby <[email protected]>
poiana
added
kind/documentation
leogr
reviewed
Jul 26, 2023
CONTRIBUTING.md
Outdated
|
|
||
| The rules maturity framework was introduced based on this [proposal](proposals/20230605-rules-adoption-management-maturity-framework.md). As specified in the tags section of the [Style Guide of Falco Rules](https://falco.org/docs/rules/style-guide/#tags), every rule upstreamed to The Falco Project must include a maturity level as its first tag. | ||
|
|
||
| A new rule typically starts as `maturity_sandbo` and, in some cases, as `maturity_incubating`. However, it cannot immediately be at the `maturity_stable` level. |
There was a problem hiding this comment.
Suggested change
| A new rule typically starts as `maturity_sandbo` and, in some cases, as `maturity_incubating`. However, it cannot immediately be at the `maturity_stable` level. | |
| A new rule typically starts as `maturity_sandbox` and, in some cases, as `maturity_incubating`. However, it cannot immediately be at the `maturity_stable` level. |
CONTRIBUTING.md
Outdated
|
|
||
| ## Maturity Levels | ||
|
|
||
| The levels (the maturity tag must be the first Falco tag): |
There was a problem hiding this comment.
Suggested change
| The levels (the maturity tag must be the first Falco tag): | |
| The levels (the maturity tag must be the first one in the rule's `tags` array): |
Co-authored-by: Leonardo Grasso <[email protected]> Signed-off-by: Melissa Kilby <[email protected]>
Signed-off-by: Melissa Kilby <[email protected]>
leogr
approved these changes
Jul 26, 2023
|
LGTM label has been added. Git tree hash: b98c78493508e343aa630d8acc2367cbff9de5de
|
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: incertum, leogr The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What type of PR is this?
/kind documentation
Any specific area of the project related to this PR?
/area documentation
What this PR does / why we need it:
Addressing
from falcosecurity/falco-website#1009
@LucaGuerra please take it away and directly push to this branch.
We could also update the PR template with the new links and checklist in this PR or open a new PR afterwards.
Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer: