leandron commented on code in PR #88: URL: https://github.com/apache/tvm-rfcs/pull/88#discussion_r947557070
########## rfcs/0088-commit-message-guideline.md: ########## @@ -0,0 +1,181 @@ +- Feature Name: Commit Message Guideline +- Start Date: 2022-08-12 +- RFC PR: [apache/tvm-rfcs#0000](https://github.com/apache/tvm-rfcs/pull/88) +- GitHub Issue: [apache/tvm#0000](https://github.com/apache/tvm/issues/0000) + +# Summary +[summary]: #summary + +This RFC proposes adding a Commmit Message Guideline to TVM documentation to +help guide contributors on how to write good commit messages when submitting +code / PRs (Pull Requests) to Apache TVM. + +# Motivation +[motivation]: #motivation + +Currently TVM commit logs are less than ideal because many commit messages lack +valuable information and don't follow any format standard. + +Valuable information is usually left behind in Github PR conversations or +discussion threads in the Discuss forum, making it hard to retrieve them when +inspecting the commit messages -- using `git log`, for instance. + +Because commit messages are an indirect but important aspect of code quality, +and also important for code maintenance, it is essential for a long term open +source project to ensure that they meet high standards. + +The importance of commit messages conveying enough context and information about +the code being changed will grow as the project grows and bad (poorly written) +commit messages can affect negatively the code quality of future changes that +would otherwise benefit from past good commit messages if they existed. + +Beyond code itself, poorly written commit messages can also affect the community +in other ways. For example, by not providing to new contributors a consistent +and complete history or context for the code changes, it can work as a barrier +for new contributions because much more time will be necessary trying to +understand what motivated a past critical but unclear change. + +Hence this Commit Message Guideline can help contributors to write good commit +messages and so improve the current situation regarding the TVM commit logs. + +# Guide-level explanation +[guide-level-explanation]: #guide-level-explanation + +Commit Message Guideline + +Apache TVM uses the Github (GH) platform for patch submission and code review +via Pull Requests (PRs). The final commit (title and body) that is merged into +the Apache TVM main tree is composed of the PR's title and body and must be kept +updated and reflecting the new changes in the code as per the reviews and +discussions. + +Although these guidelines apply essentially to the PRs’ title and body messages, +because GH auto-generates the PR’s title and body from the commits on a given +branch, it’s recommended to follow these guidelines right from the beginning, +when preparing commits in general to be submitted to the Apache TVM project. +This will ease the creation of a new PR, avoiding rework, and also will help the +review. + +The rules below will help to achieve uniformity that has several benefits, both +for review and for the code base maintenance as a whole, helping you to write +commit messages with a good quality suitable for the Apache TVM project, +allowing fast log searches, bisecting, and so on. + +_PR/commit title_: + +* Guarantee a title exists (enforced); +* Don’t use Github usernames in the title, like @username (enforced); +* Check if a tag should be present as a hint about what component(s) of the code + the commits “touch”. For example [BugFix], [CI], [microTVM], and [TVMC]. Tags + go between square brackets and appear first in the title. Tags help reviewers + to identify the PRs they can/want to review and also help the release folks + when generating the release notes (enforced); +* Use an imperative mood. Avoid titles like “Added operator X” and “Updated + image Y in the CI”, instead use the forms “Add feature X” and “Update image Y + in the CI” instead; +* Observe proper use of caps at the beginning (uppercase for the first letter) + and for acronyms, like, for instance, TVM, FVP, OpenCL. Hence instead of + “fix tvm use of opencl library”, write it as “Fix TVM use of OpenCL library”; +* No period at the end of the title is necessary. + +_PR/commit body_: + +* Guarantee a body exists (enforced); +* Don’t use Github usernames in body text, like @username (enforced); +* Avoid “bullet” commit message bodies: “bullet” commit message bodies are not + bad per se, but “bullet” commit messages without any description or + explanation is likely as bad as commits without any description, rationale, + or explanation in the body. + +For minor deviations from these guidelines, the community will normally favor +reminding the contributor of this policy over reverting or blocking a commmit / +PR. + +Commits and PRs without a title and/or a body are not considered minor +deviations from these guidelines and hence must be avoided. + +Most importantly, the contents of the commit message, especially the body, +should be written to convey the intention of the change, so it should avoid +being vague. For example, commits with a title like “Fix”, “Cleanup”, and +“Fix flaky test” and without any body text should be avoided. Also, for the +review, it will leave the reviewer wondering about what exactly was fixed or +changed and why the change is necessary, slowing the review. + +Below is an example that can be used as a model: + +> [microTVM] Zephyr: Remove zephyr_board option from build, flash, and open_transport methods +> +> Currently it’s necessary to pass the board type via ‘zephyr_board’ option to +> the Project API build, flash, and open_transport methods. +> +> However, since the board type is already configured when the project is +> created (i.e. when the generate_project method is called), it’s possible to +> avoid this redundancy by obtaining the board type from the project +> configuration files. +> +> This commit adds code to obtain the board type from the project CMake files, +> removing this option from build, flash, and open_transport methods, so it’s +> only necessary to specify the ‘zephyr_board’ option when calling +> generate_project. +> +> This commit also moves the ‘verbose’ and ‘west_cmd’ options from ‘build’ +> method to ‘generate_project’, reducing further the number of required options +> when building a project, since the ‘build’ method is usually called more often +> than the ‘generate_project’. + +If a PR is created from more than one commit (a patchset), then ideally the +changes should be split into commits in a reasonable way. For instance, if it’s Review Comment: Marking this as resolved, as the paragraph was removed. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: commits-unsubscr...@tvm.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
