From cd0194cb68cd7ff3d1055b7e45cb8a83fcb497a0 Mon Sep 17 00:00:00 2001 From: Ryan Richard Date: Tue, 15 Sep 2020 17:59:40 -0700 Subject: [PATCH 1/5] Contributor guide updates --- doc/contributing.md | 44 +++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 43 insertions(+), 1 deletion(-) diff --git a/doc/contributing.md b/doc/contributing.md index cf2788f7..88f34e56 100644 --- a/doc/contributing.md +++ b/doc/contributing.md @@ -10,6 +10,17 @@ Contributions to Pinniped are welcome. Here are some things to help you get star 1. See below for how to [build the code](#building). 1. See below for how to [run the tests](#testing). +## Meeting with the Maintainers + +The maintainers aspire to hold a video conference every other week with the Pinniped community. +Any community member may request to add topics to the agenda by contacting a [maintainer](../MAINTAINERS.md) +in advance, or by attending and raising the topic during time remaining after the agenda is covered. +Typical agenda items include topics regarding the roadmap, feature requests, bug reports, pull requests, etc. + +These meetings are currently scheduled for the first and third Thursday mornings of each month +at 8 AM Pacific Time, using this [Zoom meeting](https://VMware.zoom.us/j/95817013210?pwd=U1NDRjVvck9jNWpXUGFhYmxraWVIUT09&from=msft). +If the meeting day falls on a US holiday, please consider that occurrence of the meeting to be canceled. + ## Bugs To file a bug report, please first open an @@ -34,6 +45,17 @@ can be opened to implement the feature. For specifics on what to include in your feature request, please follow the guidelines in the issue and pull request templates. +## Issues + +Github [issues](https://github.com/suzerain-io/pinniped/issues) can also be used for general +inquiries and discussion regarding the project. + +Need an idea for a project to get started contributing? Take a look at the open +[issues](https://github.com/suzerain-io/pinniped/issues). +Also check to see if any open issues are labeled with +["good first issue"](https://github.com/suzerain-io/pinniped/labels/good%20first%20issue) +or ["help wanted"](https://github.com/suzerain-io/pinniped/labels/help%20wanted). + ## Building The [Dockerfile](../Dockerfile) at the root of the repo can be used to build and @@ -67,7 +89,21 @@ docker build . The `./hack/prepare-for-integration-tests.sh` script will create a local [`kind`](https://kind.sigs.k8s.io/) cluster on which the integration tests will run. -### Pre-commit Hooks +### Observing Tests on the Continuous Integration Environment + +CI will not be triggered on a pull request until the pull request is reviewed and +approved for CI by a project [maintainer](../MAINTAINERS.md). Once CI is triggered, +the progress and results will appear on the Github page for that +[pull request](https://github.com/suzerain-io/pinniped/pulls) as checks. Links +will appear to view the details of each check. + +## Documentation + +Any pull request which adds a new feature or changes the behavior of any feature which was previously documented +should include updates to the documentation. All documentation lives in this repository. This project aspires to +follow the Kubernetes [documentation style guide](https://kubernetes.io/docs/contribute/style/style-guide). + +## Pre-commit Hooks This project uses [pre-commit](https://pre-commit.com/) to agree on some conventions about whitespace/file encoding. @@ -77,3 +113,9 @@ $ brew install pre-commit $ pre-commit install pre-commit installed at .git/hooks/pre-commit ``` + +## Becoming a Pinniped Maintainer + +Regular contributors who are active in the Pinniped community and who have contributed at least several +significant pull requests may be considered for promotion to become a maintainer upon request. Please +contact an existing [maintainer](../MAINTAINERS.md) if you would like to be considered. From e51e51dfd4ba43989541fb78b437bda221e722f7 Mon Sep 17 00:00:00 2001 From: Ryan Richard Date: Tue, 15 Sep 2020 18:19:20 -0700 Subject: [PATCH 2/5] Add link to public Pinniped Biweekly Community Meeting agenda/notes doc --- doc/contributing.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/contributing.md b/doc/contributing.md index 88f34e56..b9810b27 100644 --- a/doc/contributing.md +++ b/doc/contributing.md @@ -16,6 +16,8 @@ The maintainers aspire to hold a video conference every other week with the Pinn Any community member may request to add topics to the agenda by contacting a [maintainer](../MAINTAINERS.md) in advance, or by attending and raising the topic during time remaining after the agenda is covered. Typical agenda items include topics regarding the roadmap, feature requests, bug reports, pull requests, etc. +A [public document](https://docs.google.com/document/d/1qYA35wZV-6bxcH5375vOnIGkNBo7e4OROgsV4Sj8WjQ) +tracks the agendas and notes for these meetings. These meetings are currently scheduled for the first and third Thursday mornings of each month at 8 AM Pacific Time, using this [Zoom meeting](https://VMware.zoom.us/j/95817013210?pwd=U1NDRjVvck9jNWpXUGFhYmxraWVIUT09&from=msft). From 7a975d98fb30097109cc5919f1409f25b61441e4 Mon Sep 17 00:00:00 2001 From: Ryan Richard Date: Wed, 16 Sep 2020 08:56:18 -0700 Subject: [PATCH 3/5] First draft of a PR template file. --- .../pull_request_template.md | 25 +++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE/pull_request_template.md diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md new file mode 100644 index 00000000..5de72b33 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -0,0 +1,25 @@ +Thank you for submitting a pull request for Pinniped! + +Before submitting, please see the guidelines in doc/contributing.md in this repo. + +Please note that a project maintainer will need to review and approve the PR +to cause CI tests to automatically start. + +Reminder: Did you remember to run all the tests described in doc/contributing.md +on your branch before submitting this PR? + +Below is a template to help you describe your PR. + +-- Please delete this line and all lines above this line before submitting the PR. Thanks! -- + +**Summary of the changes included in this PR** + +**Issue(s) addressed by this PR** +- Fixes # + +**Things to consider while reviewing this PR** + +**Suggested release note for the first release which contains this PR** +``` +release-note here +``` From f425eed07c4b8631a074ce5fc68018b7af747565 Mon Sep 17 00:00:00 2001 From: Ryan Richard Date: Wed, 16 Sep 2020 09:06:36 -0700 Subject: [PATCH 4/5] Small edits to PR template file --- .../PULL_REQUEST_TEMPLATE/pull_request_template.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md index 5de72b33..606899d3 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -2,11 +2,13 @@ Thank you for submitting a pull request for Pinniped! Before submitting, please see the guidelines in doc/contributing.md in this repo. -Please note that a project maintainer will need to review and approve the PR -to cause CI tests to automatically start. +Please note that a project maintainer will need to review and provide an +initial approval on the PR to cause CI tests to automatically start. +Also note that if you push additional commits to the PR, those commits +will need another initial approval before CI will pick them up. -Reminder: Did you remember to run all the tests described in doc/contributing.md -on your branch before submitting this PR? +Reminder: Did you remember to run all the linter, unit tests, and integration tests +described in doc/contributing.md on your branch before submitting this PR? Below is a template to help you describe your PR. @@ -20,6 +22,7 @@ Below is a template to help you describe your PR. **Things to consider while reviewing this PR** **Suggested release note for the first release which contains this PR** + ``` release-note here ``` From 4f59d9286cf210a9849d7f53eb7c59f4fa8fca5d Mon Sep 17 00:00:00 2001 From: Andrew Keesler Date: Wed, 16 Sep 2020 16:39:59 -0700 Subject: [PATCH 5/5] Update community meeting link to one which requires a host to be present Signed-off-by: Ryan Richard --- doc/contributing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/contributing.md b/doc/contributing.md index b9810b27..552dba61 100644 --- a/doc/contributing.md +++ b/doc/contributing.md @@ -20,7 +20,7 @@ A [public document](https://docs.google.com/document/d/1qYA35wZV-6bxcH5375vOnIGk tracks the agendas and notes for these meetings. These meetings are currently scheduled for the first and third Thursday mornings of each month -at 8 AM Pacific Time, using this [Zoom meeting](https://VMware.zoom.us/j/95817013210?pwd=U1NDRjVvck9jNWpXUGFhYmxraWVIUT09&from=msft). +at 8 AM Pacific Time, using this [Zoom meeting](https://VMware.zoom.us/j/94638309756?pwd=V3NvRXJIdDg5QVc0TUdFM2dYRzgrUT09). If the meeting day falls on a US holiday, please consider that occurrence of the meeting to be canceled. ## Bugs