Skip to content

Commit

Permalink
update issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
hfrick committed Oct 31, 2023
1 parent 3e38cae commit 3c20a6c
Show file tree
Hide file tree
Showing 4 changed files with 78 additions and 14 deletions.
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -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 <https://stackoverflow.com/> or <https://community.rstudio.com/> 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)
```

7 changes: 7 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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"
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -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 <https://stackoverflow.com/> or <https://community.rstudio.com/> 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 ...

14 changes: 0 additions & 14 deletions .github/ISSUE_TEMPLATE/issue_template.md

This file was deleted.

0 comments on commit 3c20a6c

Please sign in to comment.