commit | e8a2d8bad2680e359a3a7bbd061fde205872004b | [log] [tgz] |
---|---|---|
author | Gustavo Romero <gromero@users.noreply.github.com> | Wed Aug 31 20:09:10 2022 -0300 |
committer | GitHub <noreply@github.com> | Wed Aug 31 16:09:10 2022 -0700 |
tree | 88f7b11e9875af22774d133ef2393291de41f2cf | |
parent | 8eff7ee3c4c0a2cca2d96559fc861087aa6e0b97 [diff] |
[RFC] Add Commit Message Guideline (#88) * [RFC] Add Commit Message Guideline This RFC proposes adding a Commmit Message Guideline to Apache TVM documentation to help guide contributors on how to write good commit messages when submitting code / Pull Requests. Co-authored-by: Leandro Nunes <leandro.nunes@arm.com> * Remove out-of-scope paragraph As per the reviews, remove this paragraph since multiple commits / changes in a PR is out-of-scope, best fits in another guideline, and would require addtional discussions, needing a separate vote. * Be more explicit about committer and author responsibilities Be more explicit about committer and author responsibilities when the PR title and/or body need to get updated to be in sync with the code changes after a review cycle. * Clarify about capitalization in tags Clarify about the preferred capitalization in tags. Also clarify about multiple tags and acronyms when used as a tag. * Be more emphatic about no need of a period at the end of the title Be more emphatic about no need of a period at the end of the title but don't enforce it. * Make it clear that tag is enforced but capitalization is not Original proposal for this RFC had tag presence as an enforced rule. Later, text on recommendation about tag capitalization was added to the rule and it became a tad unclear if the enforcement applies to the tag presence only or also to the tag capitalization text. This commit moves the "enforced" mark before the tag capitalization text to make it clearer that it applies to the tag presence only. It also tweaks a bit the text to avoid the idea that tag presence is optional -- since it's enforced, just like it was in the original proposal. * Update rfcs/0088-commit-message-guideline.md Co-authored-by: Siyuan Feng <Hzfengsy@sjtu.edu.cn> Co-authored-by: Leandro Nunes <leandro.nunes@arm.com> Co-authored-by: Siyuan Feng <Hzfengsy@sjtu.edu.cn>
An RFC is a “Request for Change” to the TVM project. It is a design document that describes a new feature, enhancement, or process to the TVM project. RFCs should be the primary mechanism for proposing major features and changes. The author of the RFC is responsible for the discussion of the change, and for organizing the work around it. RFCs are text files, stored in the Apache TVM RFC repository, that serve as history and documentation of TVM features.
The primary audience of RFCs is the TVM development community. RFCs serve as a guide for the design and implementation of features during and after their development. A secondary audience is general users and developers who are interested in how and why a feature was designed and implemented.
To work on a major feature within the TVM project, an RFC must first be merged into the TVM RFC repository as a markdown file. Once merged, the RFC is considered to be “active” and may be implemented, with the goal of merging the implementation into the TVM project. These are steps that should be taken in the RFC process:
tvm-rfcs
repository. To allocate a new RFC number, open a PR against tvm-rfcs
(initially, you might need to use a dummy number in the filename for the RFC content; this can be updated after the RFC PR is created).L
to indicate it is a legacy RFC. For example, L0001
.Apache TVM is a compiler stack for deep learning systems. It is designed to close the gap between the productivity-focused deep learning frameworks, and the performance- and efficiency-focused hardware backends. TVM works with deep learning frameworks to provide end to end compilation to different backends.
© Contributors Licensed under an Apache-2.0 license.
TVM adopts Apache committer model. We aim to create an open source project that is maintained and owned by the community. Check out the Contributor Guide.