Skip to content
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

Add initial MAINTAINERS document #4382

Merged
merged 4 commits into from
Sep 10, 2024

Conversation

evankanderson
Copy link
Member

@evankanderson evankanderson commented Sep 5, 2024

Summary

Define a maintainership process for external contributors for Minder, including initial maintainer list (currently all Stackers).

Change Type

Mark the type of change your PR introduces:

  • Bug fix (resolves an issue without affecting existing features)
  • Feature (adds new functionality without breaking changes)
  • Breaking change (may impact existing functionalities or require documentation updates)
  • Documentation (updates or additions to documentation)
  • Refactoring or test improvements (no bug fixes or new functionality)
  • Governance change

Testing

N/A

Review Checklist:

  • Reviewed my own code for quality and clarity.
  • Added comments to complex or tricky code sections.
  • Updated any affected documentation.
  • Included tests that validate the fix or feature.
  • Checked that related changes are merged.

JAORMX
JAORMX previously approved these changes Sep 6, 2024
Copy link
Member

@ethomson ethomson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One formatting issue, and one minor nit on verbiage, but I actually wonder if this is a broader question about whether we expect this document to be rather evergreen or something that we revisit regularly? My experience is that these sorts of things often don't get updated as frequently, so something like:

Note: many project documents are currently in the Stacklok Google Drive instance. We are working to open the relevant documents for community review and feedback

Has a tendency to bitrot. I typically set the expectations that we should hold ourselves to in a document like this and then point out where we fail to do that in more dynamic / less static areas (issues, etc). But this is just my $0.02 from failing to update these sorts of docs as time changes.

MAINTAINERS.md Outdated
Comment on lines 75 to 77
Assignment of permissions for these maintainers is currently managed by Stacklok
as a matter of accident; changes to this list will need a Stacker to apply some
private automation to grant the privileges.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This para reads a little clunky to me; the automation is intentional isn't it? It doesn't feel like something we need to explain away. Maybe "because it's managed by automation" or something?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The automation is intentional, the fact that the automation is only available to Stackers because it's tied in with our general administration of https://github.com/stacklok/*, and we don't intend to open-source everything underneath that directory.

@evankanderson
Copy link
Member Author

I expect us to revisit this document when we and a foundation perform due diligence on the donation of Minder to said foundation.

JAORMX
JAORMX previously approved these changes Sep 6, 2024
@coveralls
Copy link

Coverage Status

coverage: 53.245% (+0.004%) from 53.241%
when pulling 4845647 on evankanderson:open-for-review
into 44d1523 on stacklok:main.

@lukehinds lukehinds merged commit ff05d6c into mindersec:main Sep 10, 2024
17 of 18 checks passed
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.

5 participants