2020-08-26 14:06:21 +00:00
|
|
|
# Contributing to Pinniped
|
|
|
|
|
|
2020-08-27 17:14:03 +00:00
|
|
|
Contributions to Pinniped are welcome. Here are some things to help you get started.
|
2020-08-26 14:06:21 +00:00
|
|
|
|
2020-09-11 15:43:53 +00:00
|
|
|
1. Please see the [Code of Conduct](code_of_conduct.md).
|
2020-08-27 17:14:03 +00:00
|
|
|
1. Learn about the [scope](scope.md) of the project.
|
|
|
|
|
1. Coming soon: details about how to legally contribute to the project, including CLA/DCO details.
|
2020-08-26 14:06:21 +00:00
|
|
|
1. See below for how to [file a bug report](#bugs).
|
|
|
|
|
1. See below for how to [suggest a feature](#features).
|
|
|
|
|
1. See below for how to [build the code](#building).
|
|
|
|
|
1. See below for how to [run the tests](#testing).
|
|
|
|
|
|
|
|
|
|
## Bugs
|
|
|
|
|
|
|
|
|
|
To file a bug report, please first open an
|
2020-08-27 15:21:04 +00:00
|
|
|
[issue](https://github.com/suzerain-io/pinniped/issues/new?template=bug_report.md). The project team
|
2020-08-26 14:06:21 +00:00
|
|
|
will work with you on your bug report.
|
|
|
|
|
|
2020-08-31 21:41:22 +00:00
|
|
|
Once the bug has been validated, a [pull request](https://github.com/suzerain-io/pinniped/compare)
|
2020-08-27 17:14:03 +00:00
|
|
|
can be opened to fix the bug.
|
2020-08-26 14:06:21 +00:00
|
|
|
|
|
|
|
|
For specifics on what to include in your bug report, please follow the
|
2020-08-27 17:14:03 +00:00
|
|
|
guidelines in the issue and pull request templates.
|
2020-08-26 14:06:21 +00:00
|
|
|
|
|
|
|
|
## Features
|
|
|
|
|
|
|
|
|
|
To suggest a feature, please first open an
|
2020-08-27 17:14:03 +00:00
|
|
|
[issue](https://github.com/suzerain-io/pinniped/issues/new?template=feature-proposal.md)
|
|
|
|
|
and tag it with `proposal`. The project team will work with you on your feature request.
|
2020-08-26 14:06:21 +00:00
|
|
|
|
2020-08-31 21:41:22 +00:00
|
|
|
Once the feature request has been validated, a [pull request](https://github.com/suzerain-io/pinniped/compare)
|
2020-08-27 17:14:03 +00:00
|
|
|
can be opened to implement the feature.
|
2020-08-26 14:06:21 +00:00
|
|
|
|
|
|
|
|
For specifics on what to include in your feature request, please follow the
|
2020-08-27 17:14:03 +00:00
|
|
|
guidelines in the issue and pull request templates.
|
2020-08-26 14:06:21 +00:00
|
|
|
|
|
|
|
|
## Building
|
|
|
|
|
|
2020-08-27 17:14:03 +00:00
|
|
|
The [Dockerfile](../Dockerfile) at the root of the repo can be used to build and
|
2020-09-11 15:43:53 +00:00
|
|
|
package the code. After making a change to the code, rebuild the docker image with the following command.
|
2020-08-26 14:06:21 +00:00
|
|
|
|
2020-08-27 17:14:03 +00:00
|
|
|
```bash
|
|
|
|
|
# From the root directory of the repo...
|
2020-08-26 14:06:21 +00:00
|
|
|
docker build .
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Testing
|
|
|
|
|
|
|
|
|
|
### Running Lint
|
|
|
|
|
|
2020-08-27 17:14:03 +00:00
|
|
|
```bash
|
2020-08-26 14:06:21 +00:00
|
|
|
./hack/module.sh lint
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Running Unit Tests
|
|
|
|
|
|
2020-08-27 17:14:03 +00:00
|
|
|
```bash
|
2020-09-11 15:43:53 +00:00
|
|
|
./hack/module.sh units
|
2020-08-26 14:06:21 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Running Integration Tests
|
|
|
|
|
|
2020-09-11 14:29:21 +00:00
|
|
|
```bash
|
2020-09-11 15:43:53 +00:00
|
|
|
./hack/prepare-for-integration-tests.sh && source /tmp/integration-test-env && go test -v -count 1 ./test/...
|
2020-09-11 14:29:21 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
The `./hack/prepare-for-integration-tests.sh` script will create a local
|
2020-09-11 15:43:53 +00:00
|
|
|
[`kind`](https://kind.sigs.k8s.io/) cluster on which the integration tests will run.
|
2020-08-26 14:06:21 +00:00
|
|
|
|
2020-08-27 17:14:03 +00:00
|
|
|
### Pre-commit Hooks
|
2020-08-26 14:06:21 +00:00
|
|
|
|
2020-08-27 17:14:03 +00:00
|
|
|
This project uses [pre-commit](https://pre-commit.com/) to agree on some conventions about whitespace/file encoding.
|
2020-08-26 14:06:21 +00:00
|
|
|
|
2020-08-27 17:14:03 +00:00
|
|
|
```bash
|
2020-08-26 14:06:21 +00:00
|
|
|
$ brew install pre-commit
|
|
|
|
|
[...]
|
|
|
|
|
$ pre-commit install
|
|
|
|
|
pre-commit installed at .git/hooks/pre-commit
|
|
|
|
|
```
|
