From bc27daef21dc7cb9b5ce135890f1ee723b9ec517 Mon Sep 17 00:00:00 2001 From: tqchen Date: Mon, 11 Jun 2018 21:34:37 -0700 Subject: [PATCH] [DOCS] Fix links --- CONTRIBUTORS.md | 2 +- docs/contribute/{community.md => community.rst} | 17 +++++++++++------ 2 files changed, 12 insertions(+), 7 deletions(-) rename docs/contribute/{community.md => community.rst} (93%) diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md index faca8155645c..932b27d9825b 100644 --- a/CONTRIBUTORS.md +++ b/CONTRIBUTORS.md @@ -3,7 +3,7 @@ TVM Contributors TVM adopts the Apache style model and governs by merit. We believe that it is important to create an inclusive community where everyone can use, contribute to, and influence the direction of the project. We actively invite contributors who have earned the merit to be part of the development community. -See the [community structure document](http://tvm.ai/contribute/community.html) for the explanation of community structure and contribution guidelines. +See the [community structure document](http://docs.tvm.ai/contribute/community.html) for the explanation of community structure and contribution guidelines. ## Committers - [Tianqi Chen](https://github.com/tqchen) (PMC), University of Washington diff --git a/docs/contribute/community.md b/docs/contribute/community.rst similarity index 93% rename from docs/contribute/community.md rename to docs/contribute/community.rst index 269aeb11d57d..3ddc7d2030d3 100644 --- a/docs/contribute/community.md +++ b/docs/contribute/community.rst @@ -1,4 +1,5 @@ -# TVM Community Structure +TVM Community Structure +======================= TVM adopts the Apache style model and governs by merit. We believe that it is important to create an inclusive community where everyone can use, contribute to, and influence the direction of the project. We actively invite contributors who have earned the merit to be part of the development community. There are several roles in the community: @@ -9,14 +10,16 @@ TVM adopts the Apache style model and governs by merit. We believe that it is im - Contributor Anyone who contributes to the project. This document explains responsibility and criteria for each role. -See [CONTRIBUTORS.md](https://github.com/dmlc/tvm/blob/master/CONTRIBUTORS.md) for the current list of contributors and their roles. +See `CONTRIBUTORS.md `_ for the current list of contributors and their roles. -## Project Management Committee +Project Management Committee +---------------------------- The PMC consists of a small group of active committers that moderate the discussion, provide mentorship to committers and code owners and manage the project release. PMC members need to actively manage the general project directions. Note that most major design choices and proposed changes should reach consensus among committers. -## Committer +Committer +--------- Committers are individuals who are granted the write access to the project. Committers oversee the general project directions and participates in the evaluation of the RFCs involving major design changes. We look for the following traits from potential comitters Own at least one module in the project @@ -26,7 +29,8 @@ Contribution history of high-quality documentation and tutorials to the promote History of creating clean, maintainable code and including good test cases. New committers are nominated by current committers from current code owners by providing evidence of these perspectives. -## Code Owner +Code Owner +---------- A code owner is an individual who is responsible for a specific area of the code-base. Code owners are responsible for the areas they are in charge of and oversee the code review process of the corresponding module. Changes to a specific area need to be approved by one of its owners in order to be merged. Once a pull request is approved by the designated code owner, the code can be directly merged into the repo. @@ -36,6 +40,7 @@ Good coverage of tests and documentation in the contributions Informative code reviews to help other contributors that adhere to a good standard, spot problems in contributions etc. Active participation in the discussion forum -## Reviewer +Reviewer +-------- A reviewer is an individual who actively contributed to the project and is willing to participate in the code review of new contributions. We invite reviewers from active contributors. The reviewer invitation will be sent to the potential reviewer’s email, so please log in to the discussion forum so that we can know which email address we could send an invitation to. Code owners should actively seek reviews from reviewers. High-quality code reviews prevent technical debt for long-term and are crucial to the success of the project. A pull request to the project has to be reviewed by a reviewer in order to be merged. The contributor and code owner can request code reviews from multiple reviewers. Code owner can decide if the code can be merged in case by case if some of the reviewers did not respond in time(e.g. a week) and existing reviews are sufficient. A good way to get quick reviews from others in the community is to also help to review other’s code -- so they can do the same in return.