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

[MNT,DOC] Updates to CODEOWNERS and file maintenance #1095

Closed
MatthewMiddlehurst opened this issue Jan 24, 2024 · 1 comment · Fixed by #1507
Closed

[MNT,DOC] Updates to CODEOWNERS and file maintenance #1095

MatthewMiddlehurst opened this issue Jan 24, 2024 · 1 comment · Fixed by #1507
Labels
documentation Improvements or additions to documentation maintenance Continuous integration, unit testing & package distribution

Comments

@MatthewMiddlehurst
Copy link
Member

MatthewMiddlehurst commented Jan 24, 2024

Describe the issue

We currently have a CODEOWNERS file and __author__ at the top of individual python files to denote who has worked on and maintains bits of code. However, CODEOWNERS has functional limitations based on the listed users write access to the repository and over time (especially with the fork) the __author__ list has become outdated and unreliable for maintenance.

A while back in Slack I mentioned replacing the __author__ list at the top of the file with __maintainer__, the contents of which can change as needed and is a reliable source for who to contact if necessary regarding a file. I do not really see the loss of the __author__ list as major, as they can get very bloated and commit history (very easily available through GitHub) is a much better method for tracking contributions.

Suggest a potential alternative/fix

Replace cases of __author__ with blank __maintainer__ lists and begin to populate these over time.

Additional context

Currently, the CODEOWNERS file has broken entries as a result of its usage as a maintainer tracker. Keeping maintainers listed elsewhere will allow us to fix these and use the file for its intended purpose (sending out review requests for people who want/need them).

@MatthewMiddlehurst MatthewMiddlehurst added documentation Improvements or additions to documentation maintenance Continuous integration, unit testing & package distribution labels Jan 24, 2024
@TonyBagnall
Copy link
Contributor

I agree I think, would we also get rid of the CODEOWNERS? I would like to do so. I wonder if there is a tool for collating commit history, auto generate class vs contributor record? Just a random thought

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation maintenance Continuous integration, unit testing & package distribution
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants