From b015faec1adf0dc653ca85216e23b5c39b35649c Mon Sep 17 00:00:00 2001 From: CrazyMax <1951866+crazy-max@users.noreply.github.com> Date: Thu, 13 Nov 2025 09:18:21 +0100 Subject: [PATCH] chore: contributing doc and issue templates Signed-off-by: CrazyMax <1951866+crazy-max@users.noreply.github.com> --- .github/CONTRIBUTING.md | 27 +++++++ .github/ISSUE_TEMPLATE/bug.yml | 101 ++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 9 +++ .github/ISSUE_TEMPLATE/feature.yml | 15 ++++ .github/workflows/.pr-assign-author.yml | 17 ++++ 5 files changed, 169 insertions(+) create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/ISSUE_TEMPLATE/bug.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature.yml create mode 100644 .github/workflows/.pr-assign-author.yml diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..2f03e91 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,27 @@ +## 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/github-builder-experimental/fork) and clone the repository +2. Create a new branch: `git checkout -b my-branch-name` +3. Make your changes +4. Push to your fork and [submit a pull request](https://github.com/docker/github-builder-experimental/compare) +5. 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/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 0000000..78e84e4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,101 @@ +# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema +name: Bug Report +description: Report a bug +labels: + - status/triage + +body: + - type: markdown + attributes: + value: | + Thank you for taking the time to report a bug! + If this is a security issue please report it to the [Docker Security team](mailto:security@docker.com). + + - type: checkboxes + attributes: + label: Contributing guidelines + description: > + Make sure you've read the contributing guidelines before proceeding. + options: + - label: I've read the [contributing guidelines](https://github.com/docker/github-builder-experimental/blob/master/.github/CONTRIBUTING.md) and wholeheartedly agree + required: true + + - type: checkboxes + attributes: + label: "I've found a bug, and:" + description: | + Make sure that your request fulfills all of the following requirements. + If one requirement cannot be satisfied, explain in detail why. + options: + - label: The documentation does not mention anything about my problem + - label: There are no open or closed issues that are related to my problem + + - type: textarea + attributes: + label: Description + description: > + Provide a brief description of the bug in 1-2 sentences. + validations: + required: true + + - type: textarea + attributes: + label: Expected behaviour + description: > + Describe precisely what you'd expect to happen. + validations: + required: true + + - type: textarea + attributes: + label: Actual behaviour + description: > + Describe precisely what is actually happening. + validations: + required: true + + - type: input + attributes: + label: Repository URL + description: > + Enter the URL of the repository where you are experiencing the + issue. If your repository is private, provide a link to a minimal + repository that reproduces the issue. + + - type: input + attributes: + label: Workflow run URL + description: > + Enter the URL of the GitHub Action workflow run, if public. + + - type: textarea + attributes: + label: YAML workflow + description: | + Provide the YAML of the workflow that's causing the issue. + Make sure to remove any sensitive information. + render: yaml + validations: + required: true + + - type: textarea + attributes: + label: Workflow logs + description: > + [Attach](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/attaching-files) + the [log file of your workflow run](https://docs.github.com/en/actions/managing-workflow-runs/using-workflow-run-logs#downloading-logs) + and make sure to remove any sensitive information. + + - type: textarea + attributes: + label: BuildKit logs + description: > + If applicable, provide the [BuildKit container logs](https://docs.docker.com/build/ci/github-actions/configure-builder/#buildkit-container-logs) by enabling debug mode + and reproducing the issue. + render: text + + - type: textarea + attributes: + label: Additional info + description: | + Provide any additional information that could be useful. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..a813065 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,9 @@ +# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser +blank_issues_enabled: true +contact_links: + - name: Questions and Discussions + url: https://github.com/docker/github-builder-experimental/discussions/new + about: Use Github Discussions to ask questions and/or open discussion topics. + - name: Documentation + url: https://docs.docker.com/build/ci/github-actions/ + about: Read the documentation. diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml new file mode 100644 index 0000000..6ab7568 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -0,0 +1,15 @@ +# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema +name: Feature request +description: Missing functionality? Come tell us about it! +labels: + - kind/enhancement + - status/triage + +body: + - type: textarea + id: description + attributes: + label: Description + description: What is the feature you want to see? + validations: + required: true diff --git a/.github/workflows/.pr-assign-author.yml b/.github/workflows/.pr-assign-author.yml new file mode 100644 index 0000000..3f124d2 --- /dev/null +++ b/.github/workflows/.pr-assign-author.yml @@ -0,0 +1,17 @@ +name: .pr-assign-author + +permissions: + contents: read + +on: + pull_request_target: + types: + - opened + - reopened + +jobs: + run: + uses: crazy-max/.github/.github/workflows/pr-assign-author.yml@1b673f36fad86812f538c1df9794904038a23cbf + permissions: + contents: read + pull-requests: write