Skip to content

Updates to contributors guide #2031

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
wants to merge 10 commits into
base: master
Choose a base branch
from

Conversation

alexakreizinger
Copy link
Member

@alexakreizinger alexakreizinger commented Aug 1, 2025

got rid of some defunct/redundant sections, played musical chairs with other sections for clarity, and added a "quick tips" section at the top for anyone who's just skimming.

if I went too far removing stuff, I can definitely revert some of these changes, but my thought process there is that too much content makes it harder for contributors to find (and follow) the guidelines that matter most. same rationale there for putting certain items in a collapsible <details> element.

I also opted to remove the list of active vale/markdownlint tests because I think that info is more interesting to maintainers than to contributors, and therefore more trouble than it's worth to keep current. (unless I'm mistaken, some of the warning-versus-error distinctions were already out of date.) again, not a hill I'll die on, but I would argue that linking to the place where the tests actually live is more than enough.

also also, the diff for this one is not super cute. to see how the updated contribution guide actually renders for readers, go here: https://github.com/fluent/fluent-bit-docs/blob/alexakreizinger/sc-143151/updates-to-contributor-s-guide/CONTRIBUTING.md

Signed-off-by: Alexa Kreizinger <[email protected]>
Signed-off-by: Alexa Kreizinger <[email protected]>
Signed-off-by: Alexa Kreizinger <[email protected]>
Signed-off-by: Alexa Kreizinger <[email protected]>
Signed-off-by: Alexa Kreizinger <[email protected]>
Signed-off-by: Alexa Kreizinger <[email protected]>
Signed-off-by: Alexa Kreizinger <[email protected]>
@alexakreizinger alexakreizinger marked this pull request as ready for review August 1, 2025 03:05
@alexakreizinger alexakreizinger requested review from a team as code owners August 1, 2025 03:05
Signed-off-by: Alexa Kreizinger <[email protected]>
Signed-off-by: Alexa Kreizinger <[email protected]>
Signed-off-by: Alexa Kreizinger <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant