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

docs introduce .github/CODEOWNERS for eclipse-tractusx/eclipse-tractusx.github.io #576

Closed
FaGru3n opened this issue Jan 8, 2024 · 6 comments

Comments

@FaGru3n
Copy link
Contributor

FaGru3n commented Jan 8, 2024

As this PR is not introduceing branch protection and required review count to the GH Org but to the eclipse-tractusx/eclipse-tractusx.github.io repo only, I would like to require 2 reviewers. For this repository enough stakeholders should be available doing reviews.

Maybe we should also think about to introcude .github/CODEOWNERS (for eclipse-tractusx/eclipse-tractusx.github.io). Code owners are automatically assigned to new PRs:
https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners

Originally posted by @carslen in eclipse-tractusx/.eclipsefdn#43 (comment)

@FaGru3n FaGru3n changed the title introduce .github/CODEOWNERS (for eclipse-tractusx/eclipse-tractusx.github.io docs introduce .github/CODEOWNERS for eclipse-tractusx/eclipse-tractusx.github.io Jan 8, 2024
@SebastianBezold
Copy link
Contributor

IMHO, CODEOWNERS won't add a lot of value or improvement to our current collaboration workflow.
Currently it is as follows:

  • Everyone can open a PR (contribute)
  • Before being able to merge, TWO approvals from reviewers are required
  • The approvals have to be given by people with the committer role
  • Only committers can merge an approved PR

Potential things a CODEOWNERS file could be used for:

  • Path specific permissions (i.e. /docs/release or KITs)
  • Auto-Assign reviewers on new PRs

Things that we are limited in my opinion:

  • We do only have a committer group, so assigning permissions on group level might be difficult (individual assignments would be needed i guess)

@mhellmeier
Copy link
Member

I would vote for a CODEOWNERS file. Especially for the KITs, there are some specific persons and responsibilities.

If someone creates a PR or an Issue for your KIT, you as a KIT developer don't get information that someone wants to change your KIT. You could subscribe to the repository, but in this case, you get notifications for every PR and Issue. Thus, a CODEOWNERS file would be beneficial.

@SebastianBezold
Copy link
Contributor

Hi @mhellmeier,
while I can see your points, I think, that this rather indicates a missing contribution guideline.
Why would there even be surprise PRs? Why would a contributor doing that not actively ask for feedback on the mailing list or the Matrix chat.
So I think, CODEOWNERS do mitigate that issue, but from my point of view, on the wrong end of the process.
But again, fair points, that you bring up. Would love to see more opinions on that

@mhellmeier
Copy link
Member

Why would a contributor doing that not actively ask for feedback on the mailing list or the Matrix chat.

If it is an external contributor, they may not know that there is a mailing list or Matrix chat. If it were used very actively, it could be spammy since one mail could be sent for every PR.

Take a look at the recent Markdown linter issues for the KITs: If there were a CODEOWNERS file, this would improve the process drastically. Therefore, I don't see any big disadvantages in introducing a CODEOWNERS file.

I would also like to mention one of the latest GitHub blog posts, discussing such a CODEOWNERS file and ways to keep it up-to-date automatically:
https://github.blog/2024-03-04-keeping-repository-maintainer-information-accurate/

Happy to hear your opinion on that and how we go on with it!

@arnoweiss
Copy link
Contributor

I think CODEOWNERS could help on the margins but I don't expect any big changes for the challenges we have. Would be open for a PR (and to be responsible for the DT Kit) though.

@FaGru3n
Copy link
Contributor Author

FaGru3n commented Aug 1, 2024

will close this issue but the general idea seems still valid at least from my perspective.

@FaGru3n FaGru3n closed this as completed Aug 1, 2024
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

No branches or pull requests

4 participants