From 3c20a6c8e0977b414bb77d4608875ee3c742847c Mon Sep 17 00:00:00 2001 From: Hannah Frick Date: Tue, 31 Oct 2023 15:21:30 +0000 Subject: [PATCH] update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 39 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 7 ++++ .github/ISSUE_TEMPLATE/feature_request.md | 32 +++++++++++++++++++ .github/ISSUE_TEMPLATE/issue_template.md | 14 -------- 4 files changed, 78 insertions(+), 14 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md delete mode 100644 .github/ISSUE_TEMPLATE/issue_template.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..43d9793 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,39 @@ +--- +name: "Bug Report" +about: Submit a bug report to help us improve tidymodels +--- + +### Tips for a helpful bug report: + + * Please include a **minimal reproducible example,** a reprex, to demonstrate the bug. If you've never heard of a reprex before, start by reading "[What is a reprex](https://github.com/tidyverse/reprex#what-is-a-reprex)" and following the advice there. If we can't reproduce a bug, we can't fit it. + + * Here is a good example bug report: [#46](https://github.com/tidymodels/tune/issues/46) + + * We don't want you to use confidential data; you can use a dataset from [modeldata](https://modeldata.tidymodels.org/reference/index.html), blind the data, or simulate other data to demonstrate your bug. The functions [`caret::twoClassSim()`](https://www.rdocumentation.org/packages/caret/versions/6.0-84/topics/SLC14_1) or [`caret::SLC14_1()`](https://www.rdocumentation.org/packages/caret/versions/6.0-84/topics/SLC14_1) might be good tools to simulate data for you. + + * Unless the problem is explicitly about parallel processing, please run sequentially. _Even if_ it is about parallel processing, please make sure that it runs sequentially first. + + * Use `set.seed()` to ensure any randomness in your code is reproducible. + + * Please check or to see if someone has already reported the same problem (see: [Yihui's Rule](https://yihui.name/en/2017/08/so-gh-email/)). + + * You might need to install these packages to create a reproducible example or share session info: + +```r +install.packages(c("reprex", "sessioninfo"), repos = "http://cran.r-project.org") +``` + +When you are ready to file the bug 🐛 report, please delete everything above this line: +< -- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ --> + +## The problem + +I'm having trouble with ... + +## Reproducible example + +```r +## copy your code to the clipboard and run: +reprex::reprex(si = TRUE) +``` + diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..b64beee --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,7 @@ +contact_links: + - name: Help + url: https://www.tidymodels.org/help/ + about: "Check out options for getting help on tidymodels.org" + - name: Discussion + url: https://rstd.io/tidymodels-community + about: "For discussions about tidymodels, post on Posit Community" diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..33527d1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,32 @@ +--- +name: "Feature Request" +about: Suggest a change or new feature in tidymodels +--- + +### Tips for a helpful feature request: + + * See our [contributing guidelines](https://github.com/tidymodels/tidymodels/blob/master/.github/CONTRIBUTING.md) and [development guide](https://www.tidymodels.org/contribute/) for more on design goals and how to contribute. + + * Please include a **minimal reproducible example,** a reprex, to demonstrate your feature idea when appropriate. If you've never heard of a reprex before, start by reading "[What is a reprex](https://github.com/tidyverse/reprex#what-is-a-reprex)" and following the advice there. A reproducible example can be effective at demonstrating the case for a new feature. + + * We don't want you to use confidential data; you can use a dataset from [modeldata](https://modeldata.tidymodels.org/reference/index.html), blind the data, or simulate other data to demonstrate your bug. The functions [`caret::twoClassSim()`](https://www.rdocumentation.org/packages/caret/versions/6.0-84/topics/SLC14_1) or [`caret::SLC14_1()`](https://www.rdocumentation.org/packages/caret/versions/6.0-84/topics/SLC14_1) might be good tools to simulate data for you. + + * Unless the feature is explicitly about parallel processing, please run sequentially. _Even if_ it is about parallel processing, please make sure that it runs sequentially first. + + * Use `set.seed()` to ensure any randomness in your code is reproducible. + + * Please check or to see if someone has already asked the same question (see: [Yihui's Rule](https://yihui.name/en/2017/08/so-gh-email/)). + + * You might need to install these packages to create a reproducible example or share session info: + +```r +install.packages(c("reprex", "sessioninfo"), repos = "http://cran.r-project.org") +``` + +When you are ready to file the feature ✨ request, please delete everything above this line: +< -- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ --> + +## Feature + +In situations when ... + diff --git a/.github/ISSUE_TEMPLATE/issue_template.md b/.github/ISSUE_TEMPLATE/issue_template.md deleted file mode 100644 index 898687a..0000000 --- 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. If you have a question, please don't use this form. Instead, ask on or . - -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 -```