From 2c6e6cdbe697d8b69c35745c21dbcd46a5c2bc8d Mon Sep 17 00:00:00 2001 From: CrazyMax <1951866+crazy-max@users.noreply.github.com> Date: Mon, 20 Jan 2025 12:10:32 +0100 Subject: [PATCH] chore: community files --- .github/CODE_OF_CONDUCT.md | 3 +++ .github/CONTRIBUTING.md | 32 ++++++++++++++++++++++++++++++++ .github/SECURITY.md | 12 ++++++++++++ 3 files changed, 47 insertions(+) create mode 100644 .github/CODE_OF_CONDUCT.md create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/SECURITY.md diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..db44d7e --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,3 @@ +# Code of conduct + +- [Moby community guidelines](https://github.com/moby/moby/blob/master/CONTRIBUTING.md#moby-community-guidelines) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..a0f79c5 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,32 @@ +## 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-compose-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-compose-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) diff --git a/.github/SECURITY.md b/.github/SECURITY.md new file mode 100644 index 0000000..e839895 --- /dev/null +++ b/.github/SECURITY.md @@ -0,0 +1,12 @@ +# Reporting security issues + +The project maintainers take security seriously. If you discover a security +issue, please bring it to their attention right away! + +**Please _DO NOT_ file a public issue**, instead send your report privately to +[security@docker.com](mailto:security@docker.com). + +Security reports are greatly appreciated, and we will publicly thank you for it. +We also like to send gifts—if you'd like Docker swag, make sure to let +us know. We currently do not offer a paid security bounty program, but are not +ruling it out in the future.