Skip to content

Commit

Permalink
Acb/issue templates (#4001)
Browse files Browse the repository at this point in the history
Co-authored-by: Nasfame <[email protected]>
  • Loading branch information
alexcb and Nasfame authored Apr 9, 2024
1 parent 22ecf94 commit c8c3b03
Show file tree
Hide file tree
Showing 10 changed files with 116 additions and 94 deletions.
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/01-bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Bug report
description: Report an unexpected problem
labels: ["type:bug"]
assignees: []
body:
- type: textarea
id: what-went-wrong
attributes:
label: What went wrong?
description: Can you describe what happened? Can you reproduce it? If so, please list the steps to reproduce the issue. Do you have an Earthfile that you can share which showcases the problem? If so, please include it here.
validations:
required: true
- type: textarea
id: what-should-have-happened
attributes:
label: What should have happened?
description: Can you describe the expected outcome? Have you found any workarounds? Can you share them for any other users who might be experiencing the issue?
validations:
required: true
- type: textarea
id: earthly-version
attributes:
label: What earthly version?
description: Please include the output of `earthly --version`
validations:
required: true
- type: textarea
id: buildkit-logs
attributes:
label: Buildkit Logs
description: If buildkit crashed, please include the output of `docker logs earthly-buildkitd`
validations:
required: false
- type: textarea
id: other-helpful-information
attributes:
label: Other Helpful Information
description: |
Please include any additional information you might have. e.g. the output when `--verbose` is enabled, any stack traces, or even screenshots (if text is rendered incorrectly).
validations:
required: false
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/02-documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: Documentation
description: Report missing, unclear, or incorrect documentation
labels: ["type:documentation"]
assignees: []
body:
- type: input
id: existing-documentation
attributes:
label: Does existing documentation exist?
description: Please link to the existing documentation if it exists.
validations:
required: false
- type: textarea
id: request
attributes:
label: Request
description: Please describe what's missing, unclear, or incorrect in the documentation.
validations:
required: true
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/03-enhancement.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: Small feature enhancement
description: Propose a small change to an existing feature of earthly
labels: ["type:enhancement"]
assignees: []
body:
- type: textarea
id: existing-functionality
attributes:
label: What existing functionality needs improvement?
description: Please describe the reason that you need or want this change.
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Expected Behavior
description: Please describe how you expect the change to work.
validations:
required: true
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/04-feature-proposal.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: Feature proposal
description: Submit an idea for a new feature
title: 'proposal: '
labels: ["type:proposal"]
assignees: []
body:
- type: textarea
id: use-case
attributes:
label: Use case
description: Please describe the reason that you need or want this change.
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Expected Behavior
description: Please describe how you expect the change to work. Ideally, follow the style of reproduction steps - the steps that you expect to take, followed by the expected outcome.
validations:
required: true
12 changes: 12 additions & 0 deletions .github/ISSUE_TEMPLATE/05-question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name: Question
description: Ask a general question
labels: ["type:question"]
assignees: []
body:
- type: textarea
id: question
attributes:
label: Question
description: Ask away.
validations:
required: true
34 changes: 0 additions & 34 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Community Slack
about: Join our community Slack
url: https://earthly.dev/slack
14 changes: 0 additions & 14 deletions .github/ISSUE_TEMPLATE/documentation.md

This file was deleted.

14 changes: 0 additions & 14 deletions .github/ISSUE_TEMPLATE/enhancement.md

This file was deleted.

32 changes: 0 additions & 32 deletions .github/ISSUE_TEMPLATE/feature-proposal.md

This file was deleted.

0 comments on commit c8c3b03

Please sign in to comment.