From 6808acd92e30848056a21faf373af03ddb8a3b71 Mon Sep 17 00:00:00 2001 From: Carlisia Thompson Date: Tue, 1 Dec 2020 13:01:30 -0800 Subject: [PATCH] Expand maintainer documentation (#3102) * Expand maintainer documentation Signed-off-by: Carlisia * Expand maintainer documentation, 1.5 Signed-off-by: Carlisia * Improve instructions Signed-off-by: Carlisia --- site/content/docs/main/maintainers.md | 6 ++++++ site/content/docs/v1.5/maintainers.md | 5 +++++ 2 files changed, 11 insertions(+) diff --git a/site/content/docs/main/maintainers.md b/site/content/docs/main/maintainers.md index 66cc53320..8f2d3ade0 100644 --- a/site/content/docs/main/maintainers.md +++ b/site/content/docs/main/maintainers.md @@ -16,6 +16,12 @@ Please be sure to also go through the guidance under the entire [Contribute](sta - There is no need to manually request reviewers: after the PR is created, all maintainers will be automatically added to the list (note: feel free to remove people if they are on PTO, etc). - Be familiar with the [lazy consensus](https://github.com/vmware-tanzu/velero/blob/main/GOVERNANCE.md#lazy-consensus) policy for the project. +Some tips for doing reviews: +- There are some [code standards and general guidelines](https://velero.io/docs/main/code-standards) we aim for +- We have [guidelines for writing and reviewing documentation](https://velero.io/docs/main/style-guide/) +- When reviewing a design document, ensure it follows [our format and guidelines]( https://github.com/vmware-tanzu/velero/blob/main/design/_template.md). Also, when reviewing a PR that implements a previously accepted design, ensure the associated design doc is moved to the [design/implemented](https://github.com/vmware-tanzu/velero/tree/main/design/implemented) folder. + + ## Creating a release Maintainers are expected to create releases for the project. We have parts of the process automated, and full [instructions](release-instructions). diff --git a/site/content/docs/v1.5/maintainers.md b/site/content/docs/v1.5/maintainers.md index 13a0797d2..86fe29081 100644 --- a/site/content/docs/v1.5/maintainers.md +++ b/site/content/docs/v1.5/maintainers.md @@ -16,6 +16,11 @@ Please be sure to also go through the guidance under the entire [Contribute](sta - There is no need to manually request reviewers: after the PR is created, all maintainers will be automatically added to the list (note: feel free to remove people if they are on PTO, etc). - Be familiar with the [lazy consensus](https://github.com/vmware-tanzu/velero/blob/v1.5.1/GOVERNANCE.md#lazy-consensus) policy for the project. +Some tips for doing reviews: +- There are some [code standards and general guidelines](https://velero.io/docs/main/code-standards) we aim for +- We have [guidelines for writing and reviewing documentation](https://velero.io/docs/main/style-guide/) +- When reviewing a design document, ensure it follows [our format and guidelines]( https://github.com/vmware-tanzu/velero/blob/main/design/_template.md). Also, when reviewing a PR that implements a previously accepted design, ensure the associated design doc is moved to the [design/implemented](https://github.com/vmware-tanzu/velero/tree/main/design/implemented) folder. + ## Creating a release Maintainers are expected to create releases for the project. We have parts of the process automated, and full [instructions](release-instructions).