From 3b6c6279957fea0a56fe5dcbd9f495f4c4eff265 Mon Sep 17 00:00:00 2001 From: CrazyMax Date: Tue, 17 Jan 2023 11:49:39 +0100 Subject: [PATCH] contributing docs Signed-off-by: CrazyMax --- .github/CONTRIBUTING.md | 31 +++++++++++++++++++++++++++++++ .github/SUPPORT.md | 31 +++++++++++++++++++++++++++++++ README.md | 3 +++ 3 files changed, 65 insertions(+) create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/SUPPORT.md create mode 100644 README.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..6bb1e4b --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,31 @@ +## 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/actions-toolkit/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/actions-toolkit/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: + +- 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/SUPPORT.md b/.github/SUPPORT.md new file mode 100644 index 0000000..9d8ebfe --- /dev/null +++ b/.github/SUPPORT.md @@ -0,0 +1,31 @@ +# Support [![](https://isitmaintained.com/badge/resolution/docker/actions-toolkit.svg)](https://isitmaintained.com/project/docker/actions-toolkit) + +First, [be a good guy](https://github.com/kossnocorp/etiquette/blob/master/README.md). + +## Reporting an issue + +Please do a search in [open issues](https://github.com/docker/actions-toolkit/issues?utf8=%E2%9C%93&q=) to see if the issue or feature request has already been filed. + +If you find your issue already exists, make relevant comments and add your [reaction](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments). Use a reaction in place of a "+1" comment. + +:+1: - upvote + +:-1: - downvote + +If you cannot find an existing issue that describes your bug or feature, submit an issue using the guidelines below. + +## Writing good bug reports and feature requests + +File a single issue per problem and feature request. + +* Do not enumerate multiple bugs or feature requests in the same issue. +* Do not add your issue as a comment to an existing issue unless it's for the identical input. Many issues look similar, but have different causes. + +The more information you can provide, the more likely someone will be successful reproducing the issue and finding a fix. + +You are now ready to [create a new issue](https://github.com/docker/actions-toolkit/issues/new/choose)! + +## Closure policy + +* Issues that don't have the information requested above (when applicable) will be closed immediately and the poster directed to the support guidelines. +* Issues that go a week without a response from original poster are subject to closure at our discretion. diff --git a/README.md b/README.md new file mode 100644 index 0000000..8b46e1a --- /dev/null +++ b/README.md @@ -0,0 +1,3 @@ +# Actions Toolkit + +Toolkit for Docker (GitHub) Actions.