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

Suggestion: create a CODEOWNERS file to connect modules with maintainers #377

Open
zmughal opened this issue Apr 19, 2023 · 2 comments
Open

Comments

@zmughal
Copy link
Member

zmughal commented Apr 19, 2023

Some examples:

This helps with automatically assigning to issues and PRs. Possibly starting with the listing from git grep "Cared for".

@carandraug
Copy link
Member

Beware with the use of the word "owner". We are already using it to mean the people that own/hold the copyright for individual files. This is encoded as comments in the individual files as # OWNER: ... e.g.:

https://github.com/bioperl/Bio-Tools-Phylo-PAML/blob/5658f0d3ce92c418f444a1112b2c85ad67ca2069/lib/Bio/Tools/Run/Phylo/PAML/Evolver.pm#L20

https://github.com/bioperl/Bio-Tools-Phylo-PAML/blob/5658f0d3ce92c418f444a1112b2c85ad67ca2069/bin/bp_pairwise_kaks#L20

https://github.com/bioperl/Bio-Tools-Run-Alignment-TCoffee/blob/726458dc1bb5cd28dd41c2aaa2ef3cbc68f5dc57/lib/Bio/Tools/Run/Alignment/TCoffee.pm#L26

These comments are then used to generate the POD documentation (when available).

Maybe something like "Maintainer" would be better. Also, maybe also put it on the individual files, next to the owner and author blocks?

@zmughal
Copy link
Member Author

zmughal commented Apr 26, 2023

Yes, the CODEOWNERS file is more about automating the process of maintenance. Only a suggestion if it helps with triaging. It could even be generated automatically (via dzil) from the source if that kind of # MAINTAINER: line is added to individual files.

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

2 participants