ContainerImage.Pinniped/CONTRIBUTING.md

Contributing to Pinniped

Contributions to Pinniped are welcome. Here are some things to help you get started.

Code of Conduct

Please see the Code of Conduct.

Project Scope

Learn about the scope of the project.

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 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 tracks the agendas and notes for these meetings.

These meetings are currently scheduled for the first and third Thursday mornings of each month at 9 AM Pacific Time, using this Zoom meeting. If the meeting day falls on a US holiday, please consider that occurrence of the meeting to be canceled.

Discussion

Got a question, comment, or idea? Please don't hesitate to reach out via the GitHub Discussions tab at the top of this page.

Issues

Need an idea for a project to get started contributing? Take a look at the open issues. Also check to see if any open issues are labeled with "good first issue" or "help wanted".

Bugs

To file a bug report, please first open an issue. The project team will work with you on your bug report.

Once the bug has been validated, a pull request can be opened to fix the bug.

For specifics on what to include in your bug report, please follow the guidelines in the issue and pull request templates.

Features

To suggest a feature, please first open an issue and tag it with proposal, or create a new Discussion. The project team will work with you on your feature request.

Once the feature request has been validated, a pull request 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.

CLA

We welcome contributions from everyone but we can only accept them if you sign our Contributor License Agreement (CLA). If you would like to contribute and you have not signed it, our CLA-bot will walk you through the process when you open a Pull Request. For questions about the CLA process, see the FAQ or submit a question through the GitHub issue tracker.

Building

The Dockerfile at the root of the repo can be used to build and package the code. After making a change to the code, rebuild the docker image with the following command.

# From the root directory of the repo...
docker build .

Testing

Running Lint

./hack/module.sh lint

Running Unit Tests

./hack/module.sh units

Running Integration Tests

1. Install dependencies:

   • kind
   • tilt
   • ytt
   • kubectl
   • chromedriver (and Chrome)

   On macOS, these tools can be installed with Homebrew (assuming you have Chrome installed already):

   brew install kind tilt-dev/tap/tilt k14s/tap/ytt kubectl chromedriver
   

2. Create a local Kubernetes cluster using kind:

   ./hack/kind-up.sh
   

3. Install Pinniped and supporting dependencies using tilt:

   ./hack/tilt-up.sh
   

   Tilt will continue running and live-updating the Pinniped deployment whenever the code changes.

4. Run the Pinniped integration tests:

   source /tmp/integration-test-env && go test -v -count 1 ./test/integration
   

To uninstall the test environment, run ./hack/tilt-down.sh. To destroy the local Kubernetes cluster, run ./hack/kind-down.sh.

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. Once CI is triggered, the progress and results will appear on the Github page for that pull request 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.

Pre-commit Hooks

This project uses pre-commit to agree on some conventions about whitespace/file encoding.

$ 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 if you would like to be considered.