From f8947135d6ad8b451fdbe1158f0e9f8a19905519 Mon Sep 17 00:00:00 2001 From: Abel Soares Siqueira Date: Fri, 21 Jun 2024 18:27:11 +0200 Subject: [PATCH] Updates based on feedback from @tmigot --- .../10-bug-report.yml.jinja | 4 ++-- .../20-feature-request.yml.jinja | 11 ++++++++--- .../30-usage.yml.jinja | 4 ++-- .../99-general.yml.jinja | 4 ++-- ...plates %}PULL_REQUEST_TEMPLATE.md{% endif %}.jinja | 1 - 5 files changed, 14 insertions(+), 10 deletions(-) diff --git a/template/.github/{% if AddGitHubTemplates %}ISSUE_TEMPLATE{% endif %}/10-bug-report.yml.jinja b/template/.github/{% if AddGitHubTemplates %}ISSUE_TEMPLATE{% endif %}/10-bug-report.yml.jinja index d7f2d5a8..67f693e3 100644 --- a/template/.github/{% if AddGitHubTemplates %}ISSUE_TEMPLATE{% endif %}/10-bug-report.yml.jinja +++ b/template/.github/{% if AddGitHubTemplates %}ISSUE_TEMPLATE{% endif %}/10-bug-report.yml.jinja @@ -11,7 +11,7 @@ body: Please, before submitting, make sure that: - There is not an [existing issue](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/issues) with the same question - - You have read the [contributing guide](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/blob/main/docs/src/90-contributing.md/) + - You have read the [contributing guide](https://{{ PackageOwner }}.github.io/{{ PackageName }}.jl/dev/90-contributing/) - You are following the [code of conduct](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/blob/main/CODE_OF_CONDUCT.md) The form below should help you in filling out this issue. @@ -40,7 +40,7 @@ body: id: reproduction attributes: label: Reproduction steps - description: What steps led to the bug happening? + description: What steps led to the bug happening? Please provide a minimal reproducible example. validations: required: true - type: textarea diff --git a/template/.github/{% if AddGitHubTemplates %}ISSUE_TEMPLATE{% endif %}/20-feature-request.yml.jinja b/template/.github/{% if AddGitHubTemplates %}ISSUE_TEMPLATE{% endif %}/20-feature-request.yml.jinja index fae757d0..4efa0822 100644 --- a/template/.github/{% if AddGitHubTemplates %}ISSUE_TEMPLATE{% endif %}/20-feature-request.yml.jinja +++ b/template/.github/{% if AddGitHubTemplates %}ISSUE_TEMPLATE{% endif %}/20-feature-request.yml.jinja @@ -4,12 +4,12 @@ body: - type: markdown attributes: value: | - Thanks for taking the time to fill out this bug report! + Thanks for taking the time to fill out this feature request! Please, before submitting, make sure that: - There is not an [existing issue](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/issues) with the same question - - You have read the [contributing guide](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/blob/main/docs/src/90-contributing.md/) + - You have read the [contributing guide](https://{{ PackageOwner }}.github.io/{{ PackageName }}.jl/dev/90-contributing/) - You are following the [code of conduct](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/blob/main/CODE_OF_CONDUCT.md) The form below should help you in filling out this issue. @@ -20,6 +20,11 @@ body: description: Describe the requested feature validations: required: true + - type: textarea + id: validation + attributes: + label: Validation and testing + description: How could we verify that the new feature works? What kind of tests can be done? - type: textarea id: motivation attributes: @@ -33,5 +38,5 @@ body: - type: textarea id: can-help attributes: - label: Can you help + label: Can you help? description: Can you help developing this feature? diff --git a/template/.github/{% if AddGitHubTemplates %}ISSUE_TEMPLATE{% endif %}/30-usage.yml.jinja b/template/.github/{% if AddGitHubTemplates %}ISSUE_TEMPLATE{% endif %}/30-usage.yml.jinja index 15550b37..d5189821 100644 --- a/template/.github/{% if AddGitHubTemplates %}ISSUE_TEMPLATE{% endif %}/30-usage.yml.jinja +++ b/template/.github/{% if AddGitHubTemplates %}ISSUE_TEMPLATE{% endif %}/30-usage.yml.jinja @@ -5,13 +5,13 @@ body: - type: markdown attributes: value: | - Thanks for taking the time to fill out this bug report! + Thanks for taking the time to fill out this question! Please, before submitting, make sure that: - You have checked the [documentation](https://{{ PackageOwner }}.github.io/{{ PackageName }}.jl) and haven't found enough information - There is not an [existing issue](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/issues) with the same question - - You have read the [contributing guide](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/blob/main/docs/src/90-contributing.md/) + - You have read the [contributing guide](https://{{ PackageOwner }}.github.io/{{ PackageName }}.jl/dev/90-contributing/) - You are following the [code of conduct](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/blob/main/CODE_OF_CONDUCT.md) The form below should help you in filling out this issue. diff --git a/template/.github/{% if AddGitHubTemplates %}ISSUE_TEMPLATE{% endif %}/99-general.yml.jinja b/template/.github/{% if AddGitHubTemplates %}ISSUE_TEMPLATE{% endif %}/99-general.yml.jinja index 69ea3689..544d6fa0 100644 --- a/template/.github/{% if AddGitHubTemplates %}ISSUE_TEMPLATE{% endif %}/99-general.yml.jinja +++ b/template/.github/{% if AddGitHubTemplates %}ISSUE_TEMPLATE{% endif %}/99-general.yml.jinja @@ -4,12 +4,12 @@ body: - type: markdown attributes: value: | - Thanks for taking the time to fill out this bug report! + Thanks for taking the time to fill out this issue! Please, before submitting, make sure that: - There is not an [existing issue](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/issues) with the same question - - You have read the [contributing guide](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/blob/main/docs/src/90-contributing.md/) + - You have read the [contributing guide](https://{{ PackageOwner }}.github.io/{{ PackageName }}.jl/dev/90-contributing/) - You are following the [code of conduct](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/blob/main/CODE_OF_CONDUCT.md) The form below should help you in filling out this issue. diff --git a/template/.github/{% if AddGitHubTemplates %}PULL_REQUEST_TEMPLATE.md{% endif %}.jinja b/template/.github/{% if AddGitHubTemplates %}PULL_REQUEST_TEMPLATE.md{% endif %}.jinja index 375efc5d..3564ca26 100644 --- a/template/.github/{% if AddGitHubTemplates %}PULL_REQUEST_TEMPLATE.md{% endif %}.jinja +++ b/template/.github/{% if AddGitHubTemplates %}PULL_REQUEST_TEMPLATE.md{% endif %}.jinja @@ -25,4 +25,3 @@ There is no related issue. - [ ] Tests are passing - [ ] Lint workflow is passing - [ ] Docs were updated and workflow is passing -