From d1652d59d8075c5f91e3de224f02cbadc27a99b7 Mon Sep 17 00:00:00 2001 From: dgohel Date: Sun, 31 Dec 2017 01:00:40 +0100 Subject: [PATCH] ISSUE_TEMPLATE [ci skip] --- .Rbuildignore | 1 + ISSUE_TEMPLATE.md | 26 ++++++++++++++++++++++++++ 2 files changed, 27 insertions(+) create mode 100644 ISSUE_TEMPLATE.md diff --git a/.Rbuildignore b/.Rbuildignore index ee1af053..0dd613a8 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -9,3 +9,4 @@ ^CONDUCT\.md$ ^inst/tools$ ^cran-comments\.md$ +^ISSUE_TEMPLATE\.md$ diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..e7fced56 --- /dev/null +++ b/ISSUE_TEMPLATE.md @@ -0,0 +1,26 @@ +Issues are a great way to keep track of tasks, enhancements, and bugs for your projects (https://guides.github.com/features/issues/). When submitting, you need to provide the following elements: + +### If you are reporting a bug: + +- [ ] The code that is producing the error, it has to be a minimal reproducible example. +Stackoverflow is providing good explanations about it: https://stackoverflow.com/help/mcve. You can use package `reprex` to help you: http://reprex.tidyverse.org/. The most popular R stackoverflow question is about the subject: https://stackoverflow.com/questions/5963269/how-to-make-a-great-r-reproducible-example. + +- [ ] the results of R command `sessionInfo()`. It had to be executed after you loaded the packages used by your example. This will let me know what is your version of R and what are the versions of the packages you used in your example. + +- [ ] you did checked you had the latest version of the package on CRAN (and on github if issue exists with CRAN version). + +- [ ] you searched in the *open* and *closed* issues on the github repository. + + +### If you are asking an enhancement or a new function + +Explain the value, describe the situation. + +Avoid beeing anonymous, it's not pleasant for me not knowing who talked to me. + +Any suggestions to make the documentation better is really appriciated. + +### If you are asking a question + +Don't, this is not the place where to put questions. If you are looking for help on how to use the package correctly, please visit Stackoverflow and tag your question with `[r]` and `[flextable]`. I usually read them and answer when possible. +