-
Notifications
You must be signed in to change notification settings - Fork 43
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
Improving visibility/clarity or repo status: using badge and better docs #271
Comments
cc @falcosecurity/core-maintainers |
Good to me. We also need to clarify the rules to change from one state to another. |
+1 |
+1 for all. Moreover, my 2 cents about maturity level vs scope below.
TL;DR: it might be good to distinguish:
In the example fo test-infra, maturity level would be the 3/3, but the scope: something not core/ecosystem. WDYT? |
Hey @maxgio92
|
Thank you @leogr! Looks good to me! I think it could also be unlocked (non WIP). |
See #273 Next steps: I will open PRs to add badges to READMEs of each single repo 😸 |
This has been addressed. |
Motivation
We have received feedback indicating that the current status of each repository (official, incubating, sandbox, etc.) needs to be sufficiently visible and clearly understood. So, there is a need to convey better the maturity level of each repository to enhance clarity for our users and contributors.
Feature
My proposal in this regard is to implement the following:
Revise our documentation to ensure these definitions and statuses are clearly described and consistently applied. Documentation should be adequately interlinked for easier navigation.
Add a badge to each repository, indicating its status (Stable, Incubating, Sandbox). This badge should link to a description of what each status means. (someone proposed this idea to me a couple of weeks ago - I would like to give credit to this person, but unfortunately, I can't recall who 😓 )
Alternatives
Doing nothing is always an alternative 😅 However, if we do not make these changes, there could be ongoing confusion about the purpose and status of our repositories.
Additional context
The purpose is to ensure that our repository adoption model (that demonstrated to work fine) is not only transparent but also readily perceivable to all stakeholders.
On top of that, we may also want to revise some statuses or create new ones to reflect the level of some particular repositories better. For example, I may argue that test-infra should not be considered "incubating" anymore. At the same time, it does not match the "core" definition.
Note: while revising the above points, other improvements come up. See #273 for full details.
The text was updated successfully, but these errors were encountered: