-
Notifications
You must be signed in to change notification settings - Fork 15
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 CODEOWNERS file to identify maintainers for Eiffel projects #7
Comments
We have the maintainer groups available, is it to document those changes? |
yes, it is mainly documenting who are the maintainers of all the projects. for the projects without named maintainers, they should be identified and documented. general practice followed by the open source projects is to make the list of maintainers visible within the project repositories by adding files in certain format in them, listing the maintainers so people do not have to browse through various places in order to find who should they reach out for different reasons. one of the ideas which will be proposed is to start using Github CODEOWNERS files which can contain the list of maintainers. in addition to listing maintainers in them, these files enable Github to notify those people automatically for PRs. |
I really like the idea of having a CODEOWNERS file in each of the Eiffel repositories. I also noticed on https://eiffel-community.github.io/ that the section Getting Involved stated: Since I haven't seen any contact information visible in any of the repositories I think this should be addressed properly. Can we start with the community repository to set a template, and then trickle down the list of repositories by adding issues in them too? |
I noticed the CONTACT.md only contains a list of email adresses, but I was looking for something like a bullet list in the README in each of the repositories providing the @github-usernames of the current maintainers, so it's easier to come into contact with someone directly. Also that Eiffel is on Slack is not visible at all - I'll create a separate issue for that. |
So I see two options suggested:
The second option would have the added benefit of automatically requesting reviews from the maintainers whenever a new PR is opened to the repository (without having to "watch" the repository I assume?). @eiffel-community/eiffel-community-maintainers any thougths regarding the two proposed options? |
I like the idea of documenting the maintainers through the CODEOWNERS file. It would keep the readme file cleaner, and the maintainers would automatically get notified about PRs. |
I read through the guide again https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners#codeowners-syntax and it seems possible to put an entire team (for example the maintainers group) so they should be able to stay synced, if we don't want to use specific usernames. |
As an Eiffel Community Member, I would like the project maintainers identified so that I know who to talk to when it comes to project/technical topics.
The text was updated successfully, but these errors were encountered: