astropy-project
astropy-project copied to clipboard
astropy
checklist for maintainers
@eteq recently added me as a maintainer to help with the stats package and I was wondering if there was a checklist of things that should be confirmed before accepting a pull request?
Although I do see this page: http://docs.astropy.org/en/latest/development/workflow/maintainer_workflow.html as well as another useful page (which I can't seem to find right now with a description of the code, testing, documentation, and change log)
I'd be happy to start putting a list together of things that should be checked and starting a pull request but obviously the people who have been doing this for awhile probably have a good idea what should be in the list.
cc: @astrofrog @embray
:+1:, especially a summary of labels/milestones to apply/remove (I keep being confused by affects-dev, etc.)
:+1: to the idea. I wonder if maybe this belongs in CONTRIBUTING.md, though? (or perhaps both places?)
CONTRIBUTING.md was the other link I was looking for. It would probably be good to include the checklist there and then link/include it from the documentation
@embray -- any chance you could expand expand the instructions at http://docs.astropy.org/en/latest/development/workflow/maintainer_workflow.html#using-milestones-and-labels to explain how labels should be used? Or if you want new maintainers to stay away from that for now?
I'll update that section. There's definitely some out of date information there.
@crawfordsm - you've added the checklist a long time ago, can we close this now?
I'm cc-ing @saimn to speak up if there is still something missing, as I think he was added as maintainer most recently.
The main thing I see is about the section "Using Milestones and Labels" which could be improved, to distinguish PRs and issues. It's probably because it was adapted from IPython, but it's speaks about milestones for issues, whereas for Astropy we uses milestones only (I think ?) for PRs.
Also it would be good to put there a paragraph about labels. There is a wiki page (https://github.com/astropy/astropy/wiki/Issue-labeling-convention), but not so easy to find, and a few things are missing (affects-dev and affects-release, no-changelog-entry-needed, maybe others).
One other interesting thing mentioned in that page is having a "next X.Y release +1" milestone. That could probably be useful, and certainly more useful than the Future milestone, whose goal is not clear to me.
@saimn - I always saw the Future milestone as being relevant for PRs that are in progress or where there still is discussion about whether to do something at all, i.e., it signals that it is not a release blocker for anything.
And, yes, agreed that those affects-release, etc., labels need a very clear explanation. I'm still not sure I actually understand them!
@astropy/coordinators - please transfer this issue to https://github.com/astropy/project/
FWIW, the core lib has a checklist at https://github.com/astropy/astropy/blob/9d42e676a887eec99a0e08878b048e1a63dc3968/.github/workflows/open_actions.yml#L20 now. The Project does not enforce checklist for other stuff in the org but individual package maintainers are free to copy from the core lib.
