Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: github issue template #1037

Merged
merged 1 commit into from
Feb 24, 2023
Merged

Conversation

crazy-max
Copy link
Member

@crazy-max crazy-max commented Apr 1, 2022

adds a bug report issue forms template.

will look like this:

image


image

image

Signed-off-by: CrazyMax crazy-max@users.noreply.github.com

.github/ISSUE_TEMPLATE/bug.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug.yml Outdated Show resolved Hide resolved
@jedevc
Copy link
Collaborator

jedevc commented Jul 5, 2022

Let's definitely get this in asap 🎉 - should save a lot of time going back and forth on getting reproduction details!

@crazy-max
Copy link
Member Author

crazy-max commented Aug 17, 2022

Also added "Feature request" and custom template for "Security and Vulnerabilities report" and "Questions and Discussions": https://github.com/crazy-max/buildx/issues/new/choose

image

like moby repo: https://github.com/moby/moby/issues/new/choose

Comment on lines +17 to +32
label: I've found a bug and checked that ...
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
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This reads a little weird to me with the little paragraph in between:
image

Not a blocker, but also not sure how to rephrase this to flow a little easier.

.github/ISSUE_TEMPLATE/bug.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug.yml Outdated Show resolved Hide resolved
@@ -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
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So had another thought here 😄

I wonder if we should have a little section here about Dockerfile-specific issues, where we link to the buildkit new issues page 🤔

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hum not sure how to phrase this, let's see in a follow-up but that sounds like a good idea.

@crazy-max crazy-max force-pushed the bug-template branch 2 times, most recently from 8f57d4a to 3d4d8ab Compare February 24, 2023 11:23
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
**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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not a blocker (we need to update in moby as well), but we should mention that we publicly thank them if they want to (some people may not want to, or their employer may not allow them to be mentioned)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants