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: improve issue and discussion templates #1942

Merged
merged 1 commit into from
May 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 0 additions & 9 deletions .github/DISCUSSION_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ body:
$ aqua -v

```
render: bash
validations:
required: true
- type: textarea
Expand All @@ -25,15 +24,13 @@ body:
value: |
* OS:
* CPU Architecture:
render: bash
validations:
required: true
- type: textarea
id: overview
attributes:
label: Overview
value:
render: bash
validations:
required: true
- type: textarea
Expand Down Expand Up @@ -62,7 +59,6 @@ body:
```console
$
```
render: bash
validations:
required: true
- type: textarea
Expand All @@ -74,31 +70,27 @@ body:
```console
$
```
render: bash
validations:
required: false
- type: textarea
id: expected-behaviour
attributes:
label: Expected behaviour
value:
render: bash
validations:
required: true
- type: textarea
id: actual-behaviour
attributes:
label: Actual behaviour
value:
render: bash
validations:
required: true
- type: textarea
id: important-factoid
attributes:
label: Important Factoids
value:
render: bash
validations:
required: false
- type: textarea
Expand All @@ -107,6 +99,5 @@ body:
label: Reference
value: |
*
render: bash
validations:
required: false
5 changes: 0 additions & 5 deletions .github/DISCUSSION_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,23 +7,20 @@ body:
attributes:
label: Feature Overview
value:
render: bash
validations:
required: true
- type: textarea
id: why
attributes:
label: Why is the feature needed?
description: Please explain the problem you want to solve.
render: bash
validations:
required: true
- type: textarea
id: has-breaking-change
attributes:
label: Does the feature include Breaking Changes?
description: Please explain the problem you want to solve.
render: bash
validations:
required: true
- type: textarea
Expand All @@ -42,7 +39,6 @@ body:
```yaml

```
render: bash
validations:
required: false
- type: textarea
Expand All @@ -51,6 +47,5 @@ body:
label: Reference
value: |
*
render: bash
validations:
required: false
55 changes: 0 additions & 55 deletions .github/ISSUE_TEMPLATE/Bug_Report.md

This file was deleted.

27 changes: 0 additions & 27 deletions .github/ISSUE_TEMPLATE/Feature_Request.md

This file was deleted.

114 changes: 114 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
name: Bug Report
description: If something isn't working as expected.
labels:
- bug
body:
- type: markdown
attributes:
value: |
## :warning: Please create a GitHub Discussion instead of GitHub Issue

https://github.com/orgs/aquaproj/discussions

Only maintainers can create new Issues. If needed, a maintainer will create an Issue after your Discussion been triaged and confirmed.
This way we keep Issues actionable, and free of duplicates or wrong bug reports.

- type: textarea
id: aqua-version
attributes:
label: aqua version
description: Please use the latest version.
value: |
```console
$ aqua -v

```
validations:
required: true
- type: textarea
id: environment
attributes:
label: Environment
description: |
* OS (Windows, Linux, macOS, etc)
* CPU Architecture (amd64, arm64, etc)
value: |
* OS:
* CPU Architecture:
validations:
required: true
- type: textarea
id: overview
attributes:
label: Overview
value:
validations:
required: true
- type: textarea
id: how-to-reproduce
attributes:
label: How to reproduce
description: |
Please see [the guide](https://github.com/suzuki-shunsuke/oss-contribution-guide#write-good-how-to-reproduce) too.
aqua.yaml should be not partial but complete configuration.
Please remove unneeded configuration to reproduce the issue.
value: |
aqua.yaml

```yaml

```

Other related code such as local Registry

```

```

Executed command and output

```console
$
```
validations:
required: true
- type: textarea
id: debug-output
attributes:
label: Debug output
description: Please set the environment variable `AQUA_LOG_LEVEL=debug` and run aqua and tell us the debug output.
value: |
```console
$
```
validations:
required: false
- type: textarea
id: expected-behaviour
attributes:
label: Expected behaviour
value:
validations:
required: true
- type: textarea
id: actual-behaviour
attributes:
label: Actual behaviour
value:
validations:
required: true
- type: textarea
id: important-factoid
attributes:
label: Important Factoids
value:
validations:
required: false
- type: textarea
id: reference
attributes:
label: Reference
value: |
*
validations:
required: false
3 changes: 3 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
blank_issues_enabled: true
contact_links:
- name: Discussions
url: https://github.com/orgs/aquaproj/discussions
about: Please create a discussion instead of issue
- name: Issue of Standard Registry
url: https://github.com/aquaproj/aqua-registry/issues
about: Please report issues about aqua Standard Registry
Expand Down
62 changes: 62 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
name: Feature Request
description: If you want to add a feature.
labels:
- enhancement
body:
- type: markdown
attributes:
value: |
## :warning: Please create a GitHub Discussion instead of GitHub Issue

https://github.com/orgs/aquaproj/discussions

Only maintainers can create new Issues. If needed, a maintainer will create an Issue after your Discussion been triaged and confirmed.
This way we keep Issues actionable, and free of duplicates or wrong bug reports.

- type: textarea
id: feature-overview
attributes:
label: Feature Overview
value:
validations:
required: true
- type: textarea
id: why
attributes:
label: Why is the feature needed?
description: Please explain the problem you want to solve.
validations:
required: true
- type: textarea
id: has-breaking-change
attributes:
label: Does the feature include Breaking Changes?
description: Please explain the problem you want to solve.
validations:
required: true
- type: textarea
id: example-code
attributes:
label: Example Code
description: |
Please explain the feature with code. For example, if you want a new subcommand, please explain the usage of the subcommand.
value: |
```console
$
```

Configuration

```yaml

```
validations:
required: false
- type: textarea
id: reference
attributes:
label: Reference
value: |
*
validations:
required: false