Skip to content

Contributing

Hi there! I'm thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.

Contributions to this project are released to the public under the project's open source license.

Submitting a pull request

  1. Fork and clone the repository
  2. Configure and install the dependencies: go mod download
  3. Create a new branch: git checkout -b my-branch-name
  4. Make your changes
  5. Validate: docker buildx bake validate
  6. Test your code: docker buildx bake test
  7. Build the project: docker buildx bake artifact-all image-all
  8. Push to your fork and submit a pull request
  9. Pat your self on the back and wait for your pull request to be reviewed and merged.

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

  • Make sure the README.md and any other relevant documentation are kept up-to-date.
  • I try to follow SemVer v2.0.0. Randomly breaking public APIs is not an option.
  • Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
  • Write a good commit message.

Documentation

If you want to contribute to the documentation you can test its rendering locally with the following commands:

# Build mkdocs image
docker build -t mkdocs -f ./hack/docs.Dockerfile --target base .
# Run mkdocs image and watch for changes
docker run --rm -it -p 8000:8000 -v $(pwd):/docs mkdocs
# Open http://localhost:8000 on your browser

Resources

Last update: 2021-06-25 21:24:02
Created: 2019-11-13 15:01:21