-
Notifications
You must be signed in to change notification settings - Fork 107
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #197 from MichelNivard/issue-template
Add new issue and PR templates
- Loading branch information
Showing
5 changed files
with
99 additions
and
14 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,51 @@ | ||
name: Bug Report | ||
description: File a bug report. | ||
title: "[Bug]: " | ||
labels: ["bug"] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thanks for taking the time to fill out this bug report! | ||
- type: checkboxes | ||
id: terms | ||
attributes: | ||
label: Confirm setup | ||
description: By submitting this issue, you confirm to have done the following in preparation: | ||
options: | ||
- label: I have installed the development version of `{gptstudio}` (`pak::pak("MichelNivard/gptstudio")`) and tested if the problem remains. | ||
required: true | ||
- label: I have installed the `{reprex}` and `{sessioninfo}` packages to be able to run this issue's code snippet `pak::pak(c("reprex", "sessioninfo"))`. | ||
required: true | ||
- type: textarea | ||
id: problem | ||
attributes: | ||
label: What happened? | ||
description: | | ||
Also tell us, what did you expect to happen? Be as verbose as possible. | ||
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. | ||
placeholder: Tell us what you see! | ||
value: "I was trying to do X, and when I typed/clicked Y, I found the following problem:" | ||
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: textarea | ||
id: sessioninfo | ||
attributes: | ||
label: Session info | ||
description: Please run `reprex::reprex(gptstudio::gptstudio_sitrep(), session_info = TRUE)` and paste the output here. It will provides us more context on your system. | ||
render: r | ||
- type: checkboxes | ||
id: terms | ||
attributes: | ||
label: Code of Conduct | ||
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/MichelNivard/gptstudio?tab=coc-ov-file#). | ||
options: | ||
- label: I agree to follow this project's Code of Conduct | ||
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,28 @@ | ||
name: Feature request | ||
description: Make a case for a new feature. | ||
title: "[FR]: " | ||
labels: ["feature"] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thanks for taking the time to fill out this form! | ||
- type: textarea | ||
id: case | ||
attributes: | ||
label: What would you like to have? | ||
description: | | ||
Be as verbose as possible. You can use examples from other projects. | ||
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. | ||
placeholder: Let us know your thoughts! | ||
validations: | ||
required: true | ||
- type: checkboxes | ||
id: terms | ||
attributes: | ||
label: Code of Conduct | ||
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/MichelNivard/gptstudio?tab=coc-ov-file#). | ||
options: | ||
- label: I agree to follow this project's Code of Conduct | ||
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 @@ | ||
blank_issues_enabled: true |
This file was deleted.
Oops, something went wrong.
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,19 @@ | ||
## Related issue | ||
|
||
- Closes #XX | ||
|
||
## Description of changes | ||
|
||
- | ||
|
||
## For contributors | ||
|
||
- [] I have added the relevant changes to the NEWS.md file | ||
- [] I have added relevant tests or documentation with my changes | ||
|
||
## For reviewers | ||
|
||
- [] Changes meet the acceptance criteria of the related issue | ||
- [] The contribution follows style conventions and code of conduct | ||
- [] Branch passes automated testing | ||
- [] I have incremented the package version in the DESCRIPTION file before merging |