Skip to content

Commit

Permalink
ISSUE_TEMPLATE [ci skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
davidgohel committed Dec 31, 2017
1 parent ec5d14a commit d1652d5
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 0 deletions.
1 change: 1 addition & 0 deletions .Rbuildignore
Expand Up @@ -9,3 +9,4 @@
^CONDUCT\.md$
^inst/tools$
^cran-comments\.md$
^ISSUE_TEMPLATE\.md$
26 changes: 26 additions & 0 deletions 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.

0 comments on commit d1652d5

Please sign in to comment.