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 governance description for OWNERS and MAINTAINERS files within each repo #16

Open
SteveLasker opened this issue Mar 16, 2023 · 3 comments
Labels
Governance issues to improve governance posture

Comments

@SteveLasker
Copy link
Contributor

We've recently added OWNERS and MAINTAINERS to each repo, attempting to create clarity for who has rights to the repos.
While it would be nice for Github teams to capture this in a declarative format, it's the tools we have today.

This is a tracking issue to define what Github roles are associated with the OWNERS and MAINTAINERS files within the notaryproject Governance docs.

As part of the PR, how do folks want to capture Org maintainers? Should that also be captured in the OWNERS and MAINTAINERS file for full transparency? Or, is that captured in org governance?
For reference: notation/MAINTAINERS and notation/CODEOWNERS

Copied from: oras-project/community: Add governance description for OWNERS and MAINTAINERS files within each repo #47

@SteveLasker SteveLasker added the Governance issues to improve governance posture label Mar 16, 2023
@toddysm
Copy link
Contributor

toddysm commented Mar 16, 2023

We don't need OWNERS, CODEOWNERS, and MAINTAINERS files. I agree that this information should be captured in the governance. The definition of the files is as follows:

CODEOWNERS
Lists the GitHub handles of the maintainers for the repository and it is automatically used to assign approvals for PRs. The branch policies use the CODEOWNERS file to ensure that necessary approvals are provided for PR to be merged.

Note: The CODEOWNERS file is the one that GitHub uses for the PRs. See https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners

Because the CODEOWNERS file doesn't list real names and contact information for maintainers, we agreed to have MAINTAINRS. The definition is:

MAINTAINERS
Maintainers file is used to list the GitHub handles, emails, real names, and eventual association of the maintainers of the repository.

OWNERS file is not needed.

Hope this helps.

@yizha1
Copy link
Contributor

yizha1 commented Mar 17, 2023

We've recently added OWNERS and MAINTAINERS to each repo,

@SteveLasker Maybe you mixed the OWNERS and CODEOWNERS.

@toddysm
Copy link
Contributor

toddysm commented Mar 17, 2023

The linked article explains the permission model that is implemented in GitHub. It does not specify any need for OWNERS file. It does link to the CODEOWNERS file that is the only one that has significant importance in GitHub as of now.

Let's not confuse things and just use the two files that we have already created for each repository. Those two files are CODEOWNERS and MAINTAINERS.

The ask from @SteveLasker to have their description added to the governance is still valid.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Governance issues to improve governance posture
Projects
None yet
Development

No branches or pull requests

3 participants