From 7df3392f6ebbde63fd6e1bb8dec6e048e6850d82 Mon Sep 17 00:00:00 2001 From: Ali Ok Date: Wed, 7 Jun 2023 20:29:57 +0300 Subject: [PATCH] Update repo guidelines with CLOMonitor instructions (#1346) --- .github/ISSUE_TEMPLATE/new-repo.md | 2 ++ REPOSITORY-GUIDELINES.md | 26 ++++++++++++++++++++++++++ mechanics/CREATING-A-SANDBOX-REPO.md | 2 ++ 3 files changed, 30 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/new-repo.md b/.github/ISSUE_TEMPLATE/new-repo.md index eb842a6..f8dabde 100644 --- a/.github/ISSUE_TEMPLATE/new-repo.md +++ b/.github/ISSUE_TEMPLATE/new-repo.md @@ -67,3 +67,5 @@ _You may not be able to use the Projects quick menu on this page. In that case, requiring `tide` to pass before PRs are merged. - [ ] (optional) Send a PR adding the repo to [knobots](https://github.com/knative-sandbox/knobots). + +- [ ] (optional) Send a PR adding the repo to [CLOMonitor](https://clomonitor.io/projects/cncf/knative) ([more information](/REPOSITORY-GUIDELINES.md#clomonitor-and-clotributor)). diff --git a/REPOSITORY-GUIDELINES.md b/REPOSITORY-GUIDELINES.md index 37e2d69..ebbeccd 100644 --- a/REPOSITORY-GUIDELINES.md +++ b/REPOSITORY-GUIDELINES.md @@ -202,6 +202,32 @@ should be archived, deleted, or moved out of the `knative-sandbox` organization, following the general [Procedure for Removal](#procedure-for-removal) for repositories. +## CLOMonitor and CLOTributor + +[CLOMonitor](https://clomonitor.io/) is a CNCF tool that periodically checks open source projects repositories to verify they meet certain project health best practices. + +[CLOTributor](https://clotributor.dev/) is a CNCF tool that makes it easier to discover great opportunities to become a Cloud Native contributor. + +When a new repository is created, consider adding it to CLOMonitor [data file](https://github.com/cncf/clomonitor/blob/main/data/cncf.yaml), similar to: + +```yaml + - name: eventing + url: https://github.com/knative/eventing + check_sets: + - code-lite +``` + +This will make the repository will be listed in CLOMonitor's Knative project [health report](https://clomonitor.io/projects/cncf/knative). It will also make CLOTributor to list `good-first-issue`s of the new repository. + +If you would like to exclude the repository from the health report but have the `good-first-issues` in CLOTributor, add following the field: + +```yaml + exclude: + - clomonitor +``` + +Based on the maturity of the repository, it is possible to use different `check_sets`. See CLOMonitor's [checks documentation](https://github.com/cncf/clomonitor/blob/main/docs/checks.md) for more information. + --- Contents of this page are adopted from the diff --git a/mechanics/CREATING-A-SANDBOX-REPO.md b/mechanics/CREATING-A-SANDBOX-REPO.md index 737ef97..5d0a88e 100644 --- a/mechanics/CREATING-A-SANDBOX-REPO.md +++ b/mechanics/CREATING-A-SANDBOX-REPO.md @@ -93,3 +93,5 @@ other WGs to review and approve impacting changes. - Under "Branches" add a branch protection rule for `main`: - Require status checks to pass (except `...-go-coverage` checks) - Include administrators + +1. Encourage repository sponsor to add the repository to [CLOMonitor](https://clomonitor.io/projects/cncf/knative) ([more information](/REPOSITORY-GUIDELINES.md#clomonitor-and-clotributor)).