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.
See SCOPE.md for some guidelines about what we consider in and out of scope for Pinniped.
Pinniped is better because of our contributors and maintainers. It is because of you that we can bring great software to the community. Please join us during our online community meetings, occurring every first and third Thursday of the month at 9 AM PT / 12 PM PT. Use this Zoom Link to attend and add any agenda items you wish to discuss to the notes document. Join our Google Group to receive invites to this meeting.
If the meeting day falls on a US holiday, please consider that occurrence of the meeting to be canceled.
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.
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.
Reporting security vulnerabilities
Please follow the procedure described in SECURITY.md.
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.
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 .
Running Unit Tests
Running Integration Tests
htpasswd(installed by default on MacOS, usually found in
apache2-utilspackage for linux)
On macOS, these tools can be installed with Homebrew (assuming you have Chrome installed already):
brew install kind k14s/tap/ytt k14s/tap/kapp kubectl chromedriver && brew cask install docker
Create a kind cluster, compile, create container images, and install Pinniped and supporting dependencies using:
Run the Pinniped integration tests:
source /tmp/integration-test-env && go test -v -count 1 -timeout 0 ./test/integration
After making production code changes, recompile, redeploy, and run tests again by repeating the same commands described above. If there are only test code changes, then simply run the tests again.
To destroy the local Kubernetes cluster, run
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.
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.
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.