You're welcome to contribute in whatever way you can. To make sure that contributing is a good experience for everyone, please submit an issue to discuss the change ahead of implementing (if appropriate and possible).
- Clone the repository:
git clone https://github.com/EricHripko/cnbp.git
- Edit away in your favourite environment
- Check that the code builds:
go build ./...
- Build the frontend:
docker build -t erichripko/cnbp .
- Verify functionality with tests:
go test ./...
- This will run unit tests against the components
- This will run end-to-end tests against the frontend
- Code is formatted with standard Go tooling:
go fmt ./...
- Code is linted with golangci-lint:
golangci-lint run
Once the PR is landed, GitHub Actions will automatically publish the release of the frontend to Docker Hub.
The frontend is referenced directly from Docker Hub, so it's immediately
released for everyone once published. docker pull erichripko/cnbp
might be
necessary to get the latest version of the frontend if an older version is
already stored on the daemon.