diff --git a/.github/ISSUE_TEMPLATE/01-bug_report.yml b/.github/ISSUE_TEMPLATE/01-bug_report.yml new file mode 100644 index 00000000..662a9947 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01-bug_report.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/02-documentation.yml b/.github/ISSUE_TEMPLATE/02-documentation.yml new file mode 100644 index 00000000..8c54ca8c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/02-documentation.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/03-enhancement.yml b/.github/ISSUE_TEMPLATE/03-enhancement.yml new file mode 100644 index 00000000..9c3601c6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/03-enhancement.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/04-feature-proposal.yml b/.github/ISSUE_TEMPLATE/04-feature-proposal.yml new file mode 100644 index 00000000..a810567d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/04-feature-proposal.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/05-question.yml b/.github/ISSUE_TEMPLATE/05-question.yml new file mode 100644 index 00000000..a381187e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/05-question.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index efb11adb..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -name: Bug report -about: Report an unexpected problem -title: '' -labels: type:bug -assignees: '' - ---- - -**What went wrong?** - - - - - - -**What should have happened?** - - - - -**Other Helpful Information** - diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..ed1510b6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: true +contact_links: + - name: Community Slack + about: Join our community Slack + url: https://earthly.dev/slack diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md deleted file mode 100644 index b37338d6..00000000 --- a/.github/ISSUE_TEMPLATE/documentation.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -name: Documentation -about: Report missing, unclear, or incorrect documentation -title: '' -labels: type:documentation -assignees: '' - ---- - -**Does existing documentation exist?** - - -**Request** - diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md deleted file mode 100644 index 7af11272..00000000 --- a/.github/ISSUE_TEMPLATE/enhancement.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -name: Small feature enhancement -about: Propose a small change to an existing feature of earthly -title: '' -labels: type:enhancement -assignees: '' - ---- - -**What existing functionality needs improvement?** - - -**Expected Behavior** - diff --git a/.github/ISSUE_TEMPLATE/feature-proposal.md b/.github/ISSUE_TEMPLATE/feature-proposal.md deleted file mode 100644 index 1442ec29..00000000 --- a/.github/ISSUE_TEMPLATE/feature-proposal.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -name: Feature proposal -about: Submit an idea for a new feature -title: '' -labels: type:proposal -assignees: '' - ---- - -**Use case** - - -**Expected Behavior** -