Merge pull request #111 from suzerain-io/contributor_guide_updates

Contributor guide updates
This commit is contained in:
Ryan Richard 2020-09-16 16:48:26 -07:00 committed by GitHub
commit efbe3a26c1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 73 additions and 1 deletions

View File

@ -0,0 +1,28 @@
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 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 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.
-- 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
```

View File

@ -10,6 +10,19 @@ 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 [build the code](#building).
1. See below for how to [run the tests](#testing). 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.
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/94638309756?pwd=V3NvRXJIdDg5QVc0TUdFM2dYRzgrUT09).
If the meeting day falls on a US holiday, please consider that occurrence of the meeting to be canceled.
## Bugs ## Bugs
To file a bug report, please first open an To file a bug report, please first open an
@ -34,6 +47,17 @@ can be opened to implement the feature.
For specifics on what to include in your feature request, please follow the For specifics on what to include in your feature request, please follow the
guidelines in the issue and pull request templates. 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 ## Building
The [Dockerfile](../Dockerfile) at the root of the repo can be used to build and The [Dockerfile](../Dockerfile) at the root of the repo can be used to build and
@ -67,7 +91,21 @@ docker build .
The `./hack/prepare-for-integration-tests.sh` script will create a local 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. [`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. This project uses [pre-commit](https://pre-commit.com/) to agree on some conventions about whitespace/file encoding.
@ -77,3 +115,9 @@ $ brew install pre-commit
$ pre-commit install $ pre-commit install
pre-commit installed at .git/hooks/pre-commit 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.