diff --git a/.github/ISSUE_TEMPLATE/01-bug-report.yml b/.github/ISSUE_TEMPLATE/01-bug-report.yml new file mode 100644 index 00000000..ad978dae --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01-bug-report.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/02-feature-request.yml b/.github/ISSUE_TEMPLATE/02-feature-request.yml new file mode 100644 index 00000000..86173696 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/02-feature-request.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..0086358d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: true diff --git a/.github/ISSUE_TEMPLATE/issue_template.md b/.github/ISSUE_TEMPLATE/issue_template.md deleted file mode 100644 index 177069bb..00000000 --- a/.github/ISSUE_TEMPLATE/issue_template.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -name: Bug report or feature request -about: Describe a bug you've seen or make a case for a new feature ---- - -Please briefly describe your problem and what output you expect. - -Please include a minimal reproducible example (AKA a reprex). If you've never heard of a [reprex](http://reprex.tidyverse.org/) before, start by reading . - -Brief description of the problem - -```r -# insert reprex here -``` diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..f5802402 --- /dev/null +++ b/.github/pull_request_template.md @@ -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