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

[LLVM][Maintainers] Move code owner list to Maintainers.md #110240

Merged
merged 6 commits into from
Oct 4, 2024

Conversation

nikic
Copy link
Contributor

@nikic nikic commented Sep 27, 2024

Following https://discourse.llvm.org/t/rfc-proposing-changes-to-the-community-code-ownership-policy/80714 and #107384, this PR moves the llvm CODE_OWNERS.txt to the Maintainers.md file.

The general format of the Maintainers.md file follows the current CodeOwners.rst from clang, with some minor terminology changes to account for the code owners -> maintainers migration.

This change is intended to be a pure format change, without changing any actual code owners / maintainers. The list is still very badly outdated. The intent here is to get the format change out of the way, so we can get proper diffs when replacing no longer active maintainers. If we mix both together, it will be hard to follow what actually changed.

I've tried to categorize things as best as I could, and filled in GitHub handles for people where I knew them or could determine them with some confidence.

Rendered version of the file

Following https://discourse.llvm.org/t/rfc-proposing-changes-to-the-community-code-ownership-policy/80714 and llvm#107384,
this PR moves the llvm CODE_OWNERS.txt to the Maintainers.rst file.

The format of the Maintainers.rst file follows the current
CodeOwners.rst from clang, with some minor changes to account
for the code owners -> maintainers migration.

This change is intended to be a pure format change, without
changing any actual code owners / maintainers. The list is still
very badly outdated. The intent here is to get the format change
out of the way, so we can get proper diffs when replacing no longer
active maintainers. If we mix both together, it will be hard to
follow what actually changed.

I've tried to categorize things as best as I could, and filled in
GitHub handles for people where I knew them or could determine them
with some confidence.
@nikic
Copy link
Contributor Author

nikic commented Sep 27, 2024

Adding folks who reviewed #107384 to this one.

llvm/Maintainers.rst Outdated Show resolved Hide resolved
AliasAnalysis
~~~~~~~~~~~~~~
| Hal Finkel
| hfinkel\@anl.gov (email), hfinkel (GitHub)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you linkify the github names? I think you do this with a big regex, something like:
s/, ([^ ]*) \(GitHub\)/, [\1](https://github.com/\1) (GitHub)/
(untested)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've pushed the change for that, but I'm not sure I like the result. It does give us links in the rendered version, but it also makes the text file a good bit harder to read.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For rst readability you could linkify the "GitHub" text. Also, sorry, as usual it's easy to get confused about when we're using rst or markdown. Since this is a new file, should we prefer Markdown, or is that premature?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In https://llvm.org/docs/DeveloperPolicy.html#maintainers we mention Maintainers.rst, and this is what the clang and lldb CodeOwners.rst files currently use. Personally, I wouldn't mind switching this to markdown.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've pushed another commit converting the file to markdown, here's the result: https://github.com/nikic/llvm-project/blob/llvm-maintainers/llvm/Maintainers.md

Two things that were lost along the way is the table of contents, and the suppression of linkification for the emails (apparently this can't be cleanly disabled with markdown).

@nikic nikic changed the title [LLVM][Maintainers] Move code owner list to Maintainers.rst [LLVM][Maintainers] Move code owner list to Maintainers.md Oct 4, 2024
@nikic nikic merged commit bf488ed into llvm:main Oct 4, 2024
5 of 7 checks passed
@nikic nikic deleted the llvm-maintainers branch October 4, 2024 14:13
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

Successfully merging this pull request may close these issues.

6 participants