2.1 KiB
Contributing to Pinniped
We would love for you to contribute to Pinniped! Here is a basic list of things you may want to know to get started.
- Check out our Code of Conduct.
- Learn about the scope of our project.
- Coming soon: details about how to legally contribute to the project!
- See below for how to file a bug report.
- See below for how to suggest a feature.
- See below for how to build the code.
- See below for how to run the tests.
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. 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!
Building
The Dockerfile at the root of the repo is how we build and
package the pinniped-server code. After you make a change to the code, you can
rebuild that docker image with the following command.
# From the root of the repo...
docker build .
Testing
Running Lint
./hack/module.sh lint
Running Unit Tests
./hack/module.sh unittest
Running Integration Tests
More details coming soon!
Pre-commit hooks
This project uses the 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