add 1st draft of maintainer guide; closes #2896 #3053
Conversation
MAINTAINERS.md
Outdated
| 3. Don't make it about "users vs. maintainers". Treat them like a potential future maintainer. | ||
| 4. Avoid adding to the drama. You could try to reach out privately; email may be in their GitHub profile. You will likely never hear from that individual again (problem solved) | ||
| 5. If an issue is getting out of control, lock it. | ||
| 6. If someone is *repeatedly* rude and does not correct their mistakes, you may ban them from participating in the `mochajs` org. If you do not have permission to do so, contact one which does (an "owner"). |
There was a problem hiding this comment.
double space "may ban"
MAINTAINERS.md
Outdated
| ### Meta | ||
|
|
||
| - `stale`: The "stalebot" marks things as stale and will close issues if they need feedback but haven't received any. Comment on an issue to prevent this from happening. | ||
| - `duplicate`: Any issue which is a duplicate of some other issue. Label `duplicate`, link to original issue in comment, and close. |
There was a problem hiding this comment.
There's a new GitHub syntax to marking an issue as a duplicate. Maybe mention it / link to it.
|
LGTM, great job! ❤️ |
|
please take some time to check this out, as it "formalizes" some processes that we've just kind of improvised in the past. if there's anything you think could be done better, please, let's discuss! |
|
👍 Nicely put. Also, you have a footnote about the release steps being too long, but I like what you have. Providing detailed steps, like a runbook, helps ensure consistency. |
MAINTAINERS.md
Outdated
|
|
||
| ### Semantic Versioning | ||
|
|
||
| *All* issues should have one of these three labels: |
There was a problem hiding this comment.
Should there be an exception for issues labelled "question" (since those are just support rather than requiring changes)?
There was a problem hiding this comment.
yes; I'll reword this. 👍
MAINTAINERS.md
Outdated
| ### Bugs | ||
|
|
||
| - `unconfirmed`: A maintainer has not yet or cannot reproduce; typically `needs-feedback` follows (see "Feedback & Follow-ups" below) | ||
| - `bug`: A confirmed bug |
There was a problem hiding this comment.
Currently much of our usage is "bug" for both of these with the addition of either "confirmed" or "unconfirmed". Do we want to update those?
There was a problem hiding this comment.
I can change them to something like confirmed-bug and unconfirmed-bug
MAINTAINERS.md
Outdated
| ### Meta | ||
|
|
||
| - `stale`: The "stalebot" marks things as stale and will close issues if they need feedback but haven't received any. Comment on an issue to prevent this from happening. | ||
| - `duplicate`: Any issue which is a duplicate of some other issue. Label `duplicate`, write "duplicate of #<ISSUE>" in a new comment, and close. [Read more about marking issues as duplicates](https://help.github.com/articles/about-duplicate-issues-and-pull-requests/) |
There was a problem hiding this comment.
For duplicates, is there a particular purpose the label serves that GitHub's functionality doesn't?
There was a problem hiding this comment.
probably not. we can do away w/ it.
MAINTAINERS.md
Outdated
| A major release following SemVer is "just a number". Yet, given the vast amount of projects which consume Mocha, we should avoid *frequent* breaking changes, as this becomes disruptive. | ||
| In the manner of "ripping off a band-aid", sometimes we will want to group features or breaking changes together. | ||
| If so, we can add those issues and/or PRs to a new GitHub "milestone", to keep track of what needs to go in before we release. | ||
| Typically milestones have not been useful for anything other than grouping breaking changes together. |
There was a problem hiding this comment.
Is the formatting correct here?
There are line breaks, but niether bullet points nor empty lines like paragraphs.
That may render neatly and be intentional, just double-checking.
There was a problem hiding this comment.
will double-check myself
|
todo:
|
|
We have a lot of issues that used to be labelled "bug" "unconfirmed" that are now labelled "confirmed-bug" "unconfirmed-bug": https://github.com/mochajs/mocha/issues?utf8=%E2%9C%93&q=label%3Aconfirmed-bug%20label%3Aunconfirmed-bug We also need to update Stalebot for any recent label changes, it's gone and labelled a whole slew of things stale since it's looking for the old label names (although, frankly, several of them really ought to be left stale and closed by stalebot if nobody follows up...). |
boneskull
added
semver-patch
@mochajs/core have at it