Skip to content

first cut at maintainer documentation#11332

Merged
mergify[bot] merged 1 commit intohaskell:masterfrom
geekosaur:maintainer-docs
Mar 29, 2026
Merged

first cut at maintainer documentation#11332
mergify[bot] merged 1 commit intohaskell:masterfrom
geekosaur:maintainer-docs

Conversation

@geekosaur
Copy link
Copy Markdown
Collaborator

@geekosaur geekosaur commented Dec 10, 2025 •
edited
Loading

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).

Mikolaj
Mikolaj approved these changes Dec 10, 2025
View reviewed changes
Copy link
Copy Markdown
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!

geekosaur
geekosaur commented Dec 31, 2025
View reviewed changes
Comment thread .github/README.md Outdated
geekosaur
geekosaur commented Dec 31, 2025
View reviewed changes
Comment thread MAINTAINERS.md
geekosaur
geekosaur commented Dec 31, 2025
View reviewed changes
Comment thread .github/README.md Outdated
philderbeast
philderbeast reviewed Jan 1, 2026
View reviewed changes
Comment thread .github/README.md Outdated
philderbeast
philderbeast reviewed Jan 1, 2026
View reviewed changes
Copy link
Copy Markdown
Collaborator

@philderbeast philderbeast left a comment •
edited
Loading

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
Copy Markdown
Member

Mikolaj commented Jan 15, 2026 •
edited
Loading

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
Copy Markdown
Collaborator Author

geekosaur commented Jan 19, 2026

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
Copy Markdown
Collaborator Author

geekosaur commented Jan 19, 2026 •
edited
Loading

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
Copy Markdown
Collaborator

ulysses4ever commented Jan 20, 2026

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
Copy Markdown
Collaborator Author

geekosaur commented Jan 20, 2026 •
edited
Loading

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.

@geekosaur
Copy link
Copy Markdown
Collaborator Author

geekosaur commented Jan 20, 2026

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
Copy Markdown
Collaborator

ulysses4ever commented Jan 20, 2026

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
Copy Markdown
Collaborator Author

geekosaur commented Jan 20, 2026

Most recent push renamed it.

@geekosaur geekosaur marked this pull request as ready for review March 26, 2026 19:02
@geekosaur
first cut at maintainer documentation
0a18265 
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 geekosaur added merge me Tell Mergify Bot to merge and removed attention: needs-review labels Mar 26, 2026
@mergify mergify Bot added ready and waiting Mergify is waiting out the cooldown period merge delay passed Applied (usually by Mergify) when PR approved and received no updates for 2 days queued labels Mar 26, 2026
@mergify
Copy link
Copy Markdown
Contributor

mergify Bot commented Mar 28, 2026 •
edited
Loading

Merge Queue Status

This pull request spent 1 hour 42 minutes 18 seconds in the queue, including 1 hour 32 minutes 7 seconds running CI.

Required conditions to merge
  • #approved-reviews-by >= 2 [🛡 GitHub branch protection]
  • #changes-requested-reviews-by = 0 [🛡 GitHub branch protection]
  • #review-threads-unresolved = 0 [🛡 GitHub branch protection]
  • any of [🛡 GitHub branch protection]:
    • check-success = Doctest Cabal
    • check-neutral = Doctest Cabal
    • check-skipped = Doctest Cabal
  • any of [🛡 GitHub branch protection]:
    • check-success = Meta checks
    • check-neutral = Meta checks
    • check-skipped = Meta checks
  • any of [🛡 GitHub branch protection]:
    • check-success = docs/readthedocs.org:cabal
    • check-neutral = docs/readthedocs.org:cabal
    • check-skipped = docs/readthedocs.org:cabal
  • any of [🛡 GitHub branch protection]:
    • check-success = Validate post job
    • check-neutral = Validate post job
    • check-skipped = Validate post job
  • any of [🛡 GitHub branch protection]:
    • check-success = fourmolu
    • check-neutral = fourmolu
    • check-skipped = fourmolu
  • any of [🛡 GitHub branch protection]:
    • check-success = hlint
    • check-neutral = hlint
    • check-skipped = hlint
  • any of [🛡 GitHub branch protection]:
    • check-success = Bootstrap post job
    • check-neutral = Bootstrap post job
    • check-skipped = Bootstrap post job
  • any of [🛡 GitHub branch protection]:
    • check-success = whitespace
    • check-neutral = whitespace
    • check-skipped = whitespace
  • any of [🛡 GitHub branch protection]:
    • check-success = Check sdist post job
    • check-neutral = Check sdist post job
    • check-skipped = Check sdist post job
  • any of [🛡 GitHub branch protection]:
    • check-success = Changelogs
    • check-neutral = Changelogs
    • check-skipped = Changelogs

mergify Bot added a commit that referenced this pull request Mar 28, 2026
@mergify
Merge of #11332
6d3e438
@mergify mergify Bot mentioned this pull request Mar 28, 2026
Closed
86 tasks
@mergify mergify Bot merged commit 77f39db into haskell:master Mar 29, 2026
212 checks passed
@mergify mergify Bot removed the queued label Mar 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@philderbeast philderbeast philderbeast left review comments

@Mikolaj Mikolaj Mikolaj approved these changes

@ulysses4ever ulysses4ever ulysses4ever approved these changes

Assignees

No one assigned

Labels

continuous-integration documentation merge delay passed Applied (usually by Mergify) when PR approved and received no updates for 2 days merge me Tell Mergify Bot to merge ready and waiting Mergify is waiting out the cooldown period

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@geekosaur @Mikolaj @ulysses4ever @philderbeast