-
Notifications
You must be signed in to change notification settings - Fork 722
first cut at maintainer documentation #11332
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
base: master
Are you sure you want to change the base?
Conversation
1041f25 to
c2b4f9a
Compare
Mikolaj
left a comment
There was a problem hiding this 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!
There was a problem hiding this 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.
7ea4262 to
b4b1864
Compare
|
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...". |
b4b1864 to
2d01b5d
Compare
|
That comment already existed. I added that the only thing of interest was the list of maintainers, which is now the immediately following entry. |
|
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. |
3fdcc7c to
d408790
Compare
|
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. |
|
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 |
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.
d408790 to
f92359c
Compare
|
Oh, I'm still running the preview; it hasn't been rolled out generally yet. Expect yours to go away when they do. |
This is a marvelous idea! I'm all for it. Just leave the old file name. |
|
Most recent push renamed it. |
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: