-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: 🎸 Add issue and PR templates to template
And several ISSUE_TEMPLATE files and a PULL_REQUEST_TEMPLATE to the template. ✅ Closes: #33
- Loading branch information
1 parent
7ee5a05
commit 4bb5c8b
Showing
6 changed files
with
182 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| name: Bug Report (running the package) | ||
| description: File a bug report related to running the package | ||
| title: "[Bug] " | ||
| labels: ["bug"] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thanks for taking the time to fill out this bug report! | ||
| - type: textarea | ||
| id: description | ||
| attributes: | ||
| label: Description | ||
| description: Describe the bug | ||
| validations: | ||
| required: true | ||
| - type: input | ||
| id: pkg-version | ||
| attributes: | ||
| label: Package Version | ||
| description: What version of the package are you running? | ||
| validations: | ||
| required: true | ||
| - type: input | ||
| id: version | ||
| attributes: | ||
| label: Julia Version | ||
| description: What version of Julia are you running? | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: reproduction | ||
| attributes: | ||
| label: Reproduction steps | ||
| description: What steps led to the bug happening? | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: logs | ||
| attributes: | ||
| label: Relevant log output | ||
| description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. | ||
| render: shell | ||
| - type: dropdown | ||
| id: os | ||
| attributes: | ||
| label: "Operating System" | ||
| description: What is the impacted environment? | ||
| multiple: true | ||
| options: | ||
| - Windows | ||
| - Linux | ||
| - Mac | ||
| - type: checkboxes | ||
| id: checks | ||
| attributes: | ||
| label: Checks | ||
| description: Confirm the following, please | ||
| options: | ||
| - label: There is not an [existing issue](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/issues) with the same question | ||
| required: true | ||
| - label: I have read the [contributing guide](../docs/src/contributing.md) | ||
| required: true | ||
| - label: I agree with the [code of conduct](../CODE_OF_CONDUCT.md) | ||
| required: true |
37 changes: 37 additions & 0 deletions
37
template/.github/ISSUE_TEMPLATE/20-feature-request.yml.jinja
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| name: "Feature Request" | ||
| description: Suggest a new feature for the package | ||
| body: | ||
| - type: textarea | ||
| id: description | ||
| attributes: | ||
| label: Description | ||
| description: Describe the requested feature | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: motivation | ||
| attributes: | ||
| label: Motivation | ||
| description: Explain why this feature is relevant | ||
| - type: textarea | ||
| id: target | ||
| attributes: | ||
| label: Target audience | ||
| description: Tell more about the users of this feature, or where it could be useful | ||
| - type: textarea | ||
| id: can-help | ||
| attributes: | ||
| label: Can you help | ||
| description: Can you help developing this feature? | ||
| - type: checkboxes | ||
| id: checks | ||
| attributes: | ||
| label: Checks | ||
| description: Confirm the following, please | ||
| options: | ||
| - label: There is not an [existing issue](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/issues) with the same question | ||
| required: true | ||
| - label: I have read the [contributing guide](../docs/src/contributing.md) | ||
| required: true | ||
| - label: I agree with the [code of conduct](../CODE_OF_CONDUCT.md) | ||
| required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| name: "Usage question" | ||
| description: Questions related to the usage | ||
| labels: ["documentation"] | ||
| body: | ||
| - type: textarea | ||
| id: description | ||
| attributes: | ||
| label: Description | ||
| description: Write your question | ||
| validations: | ||
| required: true | ||
| - type: checkboxes | ||
| id: checks | ||
| attributes: | ||
| label: Checks | ||
| description: Confirm the following, please | ||
| options: | ||
| - label: I have checked the [documentation](https://{{ PackageOwner }}.github.io/{{ PackageName }}.jl) and haven't found enough information | ||
| required: true | ||
| - label: There is not an [existing issue](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/issues) with the same question | ||
| required: true | ||
| - label: I have read the [contributing guide](../docs/src/contributing.md) | ||
| required: true | ||
| - label: I agree with the [code of conduct](../CODE_OF_CONDUCT.md) | ||
| required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| name: "General issue" | ||
| description: In case none of the others templates apply | ||
| body: | ||
| - type: textarea | ||
| id: description | ||
| attributes: | ||
| label: Description | ||
| description: Describe the issue | ||
| validations: | ||
| required: true | ||
| - type: checkboxes | ||
| id: checks | ||
| attributes: | ||
| label: Checks | ||
| description: Confirm the following, please | ||
| options: | ||
| - label: There is not an [existing issue](https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/issues) with the same question | ||
| required: true | ||
| - label: I have read the [contributing guide](../docs/src/contributing.md) | ||
| required: true | ||
| - label: I agree with the [code of conduct](../CODE_OF_CONDUCT.md) | ||
| required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| blank_issues_enabled: false | ||
| contact_links: | ||
| - name: Discussions | ||
| url: https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/discussions | ||
| about: Create and follow discussions here |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| <!-- | ||
| Thanks for making a pull request to {{ PackageName }}.jl. | ||
| We have added this PR template to help you help us. | ||
| Make sure to read the contributing guidelines and abide to the code of conduct. | ||
| See the comments below, fill the required fields, and check the items. | ||
| --> | ||
|
|
||
| ## Related issues | ||
|
|
||
| <!-- We normally work with (i) create issue; (ii) discussion if necessary; (iii) create PR. So, at least one of the following should be true:--> | ||
|
|
||
| <!-- Option 1, this closes an existing issue. Fill the number below--> | ||
| Closes # | ||
|
|
||
| <!-- Option 2, this is a small fix that arguably won't need an issue. Uncomment below --> | ||
| <!-- | ||
| There is no related issue. | ||
| --> | ||
|
|
||
| ## Checklist | ||
|
|
||
| <!-- mark true if NA --> | ||
| <!-- leave PR as draft until all is checked --> | ||
| - [ ] I am following the [contributing guidelines](../docs/src/contributing.md) | ||
| - [ ] Tests are passing | ||
| - [ ] Lint workflow is passing | ||
| - [ ] Docs were updated and workflow is passing | ||
| <!-- - [ ] [CHANGELOG.md](../CHANGELOG.md) was updated --> |