wangdepei
f8e8d6214e
Some checks failed
ci / main () (push) Has been cancelled
ci / main (cloud:latest) (push) Has been cancelled
ci / main (cloud:v0.11.2-desktop.2) (push) Has been cancelled
ci / main (lab:latest) (push) Has been cancelled
ci / main (latest) (push) Has been cancelled
ci / main (v0.4.1) (push) Has been cancelled
ci / multi (push) Has been cancelled
ci / error (push) Has been cancelled
ci / debug (push) Has been cancelled
ci / install (push) Has been cancelled
ci / use (false) (push) Has been cancelled
ci / use (true) (push) Has been cancelled
ci / driver (image=moby/buildkit:latest) (push) Has been cancelled
ci / driver (image=moby/buildkit:master
network=host
) (push) Has been cancelled
ci / docker-driver (push) Has been cancelled
ci / endpoint (push) Has been cancelled
ci / config (push) Has been cancelled
ci / config-inline (push) Has been cancelled
ci / with-qemu (, all) (push) Has been cancelled
ci / with-qemu (, arm64,riscv64,arm) (push) Has been cancelled
ci / with-qemu (v0.9.1, all) (push) Has been cancelled
ci / with-qemu (v0.9.1, arm64,riscv64,arm) (push) Has been cancelled
ci / build-ref (cb185f095fd3d9444e0aa605d3789e9e05f2a1e7) (push) Has been cancelled
ci / build-ref (master) (push) Has been cancelled
ci / build-ref (refs/pull/731/head) (push) Has been cancelled
ci / build-ref (refs/tags/v0.5.1) (push) Has been cancelled
ci / standalone-cmd (push) Has been cancelled
ci / standalone-action (push) Has been cancelled
ci / standalone-install-error (push) Has been cancelled
ci / append (push) Has been cancelled
ci / platforms (push) Has been cancelled
ci / docker-context (push) Has been cancelled
ci / cleanup (false) (push) Has been cancelled
ci / cleanup (true) (push) Has been cancelled
ci / k3s (v0.10.5) (push) Has been cancelled
ci / k3s (v0.11.0) (push) Has been cancelled
ci / cache-binary (false) (push) Has been cancelled
ci / cache-binary (true) (push) Has been cancelled
33 lines
1.9 KiB
Markdown
33 lines
1.9 KiB
Markdown
## 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](https://docs.github.com/en/github/site-policy/github-terms-of-service#6-contributions-under-repository-license)
|
|
to the public under the [project's open source license](LICENSE).
|
|
|
|
## Submitting a pull request
|
|
|
|
1. [Fork](https://github.com/docker/setup-buildx-action/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](https://github.com/docker/setup-buildx-action/compare)
|
|
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:
|
|
|
|
- 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](https://semver.org/). 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](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
|
|
|
|
## Resources
|
|
|
|
- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
|
|
- [Using Pull Requests](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests)
|
|
- [GitHub Help](https://docs.github.com/en)
|