Skip to content

Conversation

@geekosaur
Copy link
Collaborator

@geekosaur geekosaur commented Dec 10, 2025

Highly incomplete, but open to additions.
Also move things from the contributor guide and a few things to it, and absorb the old maintainers list.


Template B: This PR does not modify behaviour or interface

E.g. the PR only touches documentation or tests, does refactorings, etc.

Include the following checklist in your PR:

  • Patches conform to the coding conventions.
  • Is this a PR that fixes CI? If so, it will need to be backported to older cabal release branches (ask maintainers for directions).

Copy link
Member

@Mikolaj Mikolaj left a comment

Choose a reason for hiding this comment

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

I don't ATM have the time to read thoroughly and make suggestions, but this is a great start!

Copy link
Collaborator

@philderbeast philderbeast left a comment

Choose a reason for hiding this comment

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

I couldn't leave a review without a comment, seems too much to ask when all I found was a comnstraints typo.

@geekosaur geekosaur force-pushed the maintainer-docs branch 2 times, most recently from 7ea4262 to b4b1864 Compare January 1, 2026 22:27
@Mikolaj
Copy link
Member

Mikolaj commented Jan 15, 2026

Please add a big note at the top saying "if you are a cabal dev, you don't need to read this, at least until you need to escalate anything...".

@geekosaur
Copy link
Collaborator Author

That comment already existed. I added that the only thing of interest was the list of maintainers, which is now the immediately following entry.

@geekosaur
Copy link
Collaborator Author

geekosaur commented Jan 19, 2026

I am moderately annoyed that the ability to view the file tree associated with a PR seems to have been removed. (Specifically, I want to see how GitHub renders the document.) Thanks yet again for being "useful", GitHub.


ETA: found a way to do it still, on the "Commits" tab.

@geekosaur geekosaur force-pushed the maintainer-docs branch 2 times, most recently from 3fdcc7c to d408790 Compare January 20, 2026 00:19
@ulysses4ever
Copy link
Collaborator

Was it really necessary to rename the file with the list of maintainers? I referenced it in many places already. I’d really appreciate it if the name could stay the same.

PS I still see the file tree at the same spot as before, on the Files changed tab on the left.

@geekosaur
Copy link
Collaborator Author

geekosaur commented Jan 20, 2026

I can stick a pointer there, or rename this file again; I was under the impression from Mikołaj's comments on the call that he wanted them to be integrated (specifically, that the list of maintainers should be at the top of this file). And nobody protested when I suggested CABAL-MAINTAINERS.md for this one, to make it clearer that this isn't intended for contributors.

Highly incomplete. Also, revise contributor documentation including
moving some things to the maintainer documentation and absorbing the old
maintainers list which is now at the top.
@geekosaur
Copy link
Collaborator Author

Oh, I'm still running the preview; it hasn't been rolled out generally yet. Expect yours to go away when they do.

@ulysses4ever
Copy link
Collaborator

he wanted them to be integrated

This is a marvelous idea! I'm all for it. Just leave the old file name.

@geekosaur
Copy link
Collaborator Author

Most recent push renamed it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants