docker-metadata/.github/CONTRIBUTING.md

Contributing

Hi there! We're 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: yarn install
3. Create a new branch: git checkout -b my-branch-name
4. Make your changes
5. Make sure the tests pass: docker buildx bake test
6. Format code and build javascript artifacts: docker buildx bake pre-checkin
7. Validate all code has correctly formatted and built: docker buildx bake validate
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.

Container based developer flow

If you don't want to maintain a Node developer environment that fits this project you can use containerized commands instead of invoking yarn directly.

# format code and build javascript artifacts
docker buildx bake pre-checkin

# validate all code has correctly formatted and built
docker buildx bake validate

# run tests
docker buildx bake test

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

• Write tests.
• Make sure the README.md and any other relevant documentation are kept up-to-date.
• We 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.

Resources

• How to Contribute to Open Source
• Using Pull Requests
• GitHub Help