Add maintainers best practice document and update maintainer list #7311
Conversation
daxian-dbw
requested review from
SteveL-MSFT,
TravisEz13,
adityapatwardhan,
anmenaga,
iSazonov and
joeyaiello
| the PR title will be used as the commit title by default. | ||
| **Reword the title as needed** to make sure it makes sense (can be used without change in `CHANGELOG.md`). | ||
| 1. The commit description is required for feature PRs or PRs with breaking changes. | ||
| For other PRs, it's not required but good to have based on the judgement of the maintainer. |
docs/maintainers/best-practice.md
Outdated
| 1. The commit description is required for feature PRs or PRs with breaking changes. | ||
| For other PRs, it's not required but good to have based on the judgement of the maintainer. | ||
| - If a PR introduces breaking changes, | ||
| make sure you put the tag `[breaking change]` at the first line of the description, |
There was a problem hiding this comment.
Header or description? Git consider first line of a commit description as a header. GitHub split and show input field for commit header (first line of the commit description) and second field for commit description (starting with second line of the commit description).
There was a problem hiding this comment.
Experimenting with images to see if that can make it clear about Commit Title and Commit Description. But images don't look very good here. May change again, stay tuned.
|
@iSazonov I think it's much more clear and also look better now. Please take another look. |
| * Andy Schwartzmeyer ([andschwa](https://github.com/andschwa)) | ||
| * Aditya Patwardhan ([adityapatwardhan](https://github.com/adityapatwardhan)) | ||
| * Ilya Sazonov ([iSazonov](https://github.com/iSazonov)) | ||
| - Dongbo Wang ([daxian-dbw](https://github.com/daxian-dbw)) |
There was a problem hiding this comment.
Ironically, in this case PR Summary does not entirely correctly summaries the changes. :)
PR Summary += "... and updating maintainer list"
docs/maintainers/best-practice.md
Outdated
|
|
||
| - Ask the author to reword the PR title based on guidelines in [Contributing](../../.github/CONTRIBUTING.md). | ||
| - Ask the author to apply `[Feature]` tag to trigger full test builds if it's necessary. | ||
| - Label the PR with `Breaking-Change` and/or `Documentation Needed` as appropriate. |
There was a problem hiding this comment.
I would also add "... and add PR classification using other Labels if they are missing".
There was a problem hiding this comment.
Good point. Will update.
anmenaga
added
the
Area-Maintainers-Documentation
daxian-dbw
changed the title
6 participants
PR Summary
Add document about best practices for maintainers.
PR Checklist
.h,.cpp,.cs,.ps1and.psm1files have the correct copyright headerWIP:to the beginning of the title and remove the prefix when the PR is ready.[feature]if the change is significant or affects feature tests