Skip to content

Commit 93fe717

Browse files
authored
Merge pull request #19 from crazy-max/community-files2
chore: contributing doc and issue templates
2 parents dd580ce + b015fae commit 93fe717

File tree

5 files changed

+169
-0
lines changed

5 files changed

+169
-0
lines changed

.github/CONTRIBUTING.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
## Contributing
2+
3+
Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
4+
5+
Contributions to this project are [released](https://docs.github.com/en/github/site-policy/github-terms-of-service#6-contributions-under-repository-license)
6+
to the public under the [project's open source license](../LICENSE).
7+
8+
## Submitting a pull request
9+
10+
1. [Fork](https://github.com/docker/github-builder-experimental/fork) and clone the repository
11+
2. Create a new branch: `git checkout -b my-branch-name`
12+
3. Make your changes
13+
4. Push to your fork and [submit a pull request](https://github.com/docker/github-builder-experimental/compare)
14+
5. Pat your self on the back and wait for your pull request to be reviewed and merged.
15+
16+
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
17+
18+
- Make sure the `README.md` and any other relevant **documentation are kept up-to-date**.
19+
- We try to follow [SemVer v2.0.0](https://semver.org/). Randomly breaking public APIs is not an option.
20+
- 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**.
21+
- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
22+
23+
## Resources
24+
25+
- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
26+
- [Using Pull Requests](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests)
27+
- [GitHub Help](https://docs.github.com/en)

.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema
2+
name: Bug Report
3+
description: Report a bug
4+
labels:
5+
- status/triage
6+
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thank you for taking the time to report a bug!
12+
If this is a security issue please report it to the [Docker Security team](mailto:security@docker.com).
13+
14+
- type: checkboxes
15+
attributes:
16+
label: Contributing guidelines
17+
description: >
18+
Make sure you've read the contributing guidelines before proceeding.
19+
options:
20+
- label: I've read the [contributing guidelines](https://github.com/docker/github-builder-experimental/blob/master/.github/CONTRIBUTING.md) and wholeheartedly agree
21+
required: true
22+
23+
- type: checkboxes
24+
attributes:
25+
label: "I've found a bug, and:"
26+
description: |
27+
Make sure that your request fulfills all of the following requirements.
28+
If one requirement cannot be satisfied, explain in detail why.
29+
options:
30+
- label: The documentation does not mention anything about my problem
31+
- label: There are no open or closed issues that are related to my problem
32+
33+
- type: textarea
34+
attributes:
35+
label: Description
36+
description: >
37+
Provide a brief description of the bug in 1-2 sentences.
38+
validations:
39+
required: true
40+
41+
- type: textarea
42+
attributes:
43+
label: Expected behaviour
44+
description: >
45+
Describe precisely what you'd expect to happen.
46+
validations:
47+
required: true
48+
49+
- type: textarea
50+
attributes:
51+
label: Actual behaviour
52+
description: >
53+
Describe precisely what is actually happening.
54+
validations:
55+
required: true
56+
57+
- type: input
58+
attributes:
59+
label: Repository URL
60+
description: >
61+
Enter the URL of the repository where you are experiencing the
62+
issue. If your repository is private, provide a link to a minimal
63+
repository that reproduces the issue.
64+
65+
- type: input
66+
attributes:
67+
label: Workflow run URL
68+
description: >
69+
Enter the URL of the GitHub Action workflow run, if public.
70+
71+
- type: textarea
72+
attributes:
73+
label: YAML workflow
74+
description: |
75+
Provide the YAML of the workflow that's causing the issue.
76+
Make sure to remove any sensitive information.
77+
render: yaml
78+
validations:
79+
required: true
80+
81+
- type: textarea
82+
attributes:
83+
label: Workflow logs
84+
description: >
85+
[Attach](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/attaching-files)
86+
the [log file of your workflow run](https://docs.github.com/en/actions/managing-workflow-runs/using-workflow-run-logs#downloading-logs)
87+
and make sure to remove any sensitive information.
88+
89+
- type: textarea
90+
attributes:
91+
label: BuildKit logs
92+
description: >
93+
If applicable, provide the [BuildKit container logs](https://docs.docker.com/build/ci/github-actions/configure-builder/#buildkit-container-logs) by enabling debug mode
94+
and reproducing the issue.
95+
render: text
96+
97+
- type: textarea
98+
attributes:
99+
label: Additional info
100+
description: |
101+
Provide any additional information that could be useful.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# 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
2+
blank_issues_enabled: true
3+
contact_links:
4+
- name: Questions and Discussions
5+
url: https://github.com/docker/github-builder-experimental/discussions/new
6+
about: Use Github Discussions to ask questions and/or open discussion topics.
7+
- name: Documentation
8+
url: https://docs.docker.com/build/ci/github-actions/
9+
about: Read the documentation.

.github/ISSUE_TEMPLATE/feature.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema
2+
name: Feature request
3+
description: Missing functionality? Come tell us about it!
4+
labels:
5+
- kind/enhancement
6+
- status/triage
7+
8+
body:
9+
- type: textarea
10+
id: description
11+
attributes:
12+
label: Description
13+
description: What is the feature you want to see?
14+
validations:
15+
required: true
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: .pr-assign-author
2+
3+
permissions:
4+
contents: read
5+
6+
on:
7+
pull_request_target:
8+
types:
9+
- opened
10+
- reopened
11+
12+
jobs:
13+
run:
14+
uses: crazy-max/.github/.github/workflows/pr-assign-author.yml@1b673f36fad86812f538c1df9794904038a23cbf
15+
permissions:
16+
contents: read
17+
pull-requests: write

0 commit comments

Comments
 (0)