.github/SUPPORT.md

Getting help with driftR

Thanks for using driftR. Before filing an issue, there are a few places to explore and pieces to put together to make the process as smooth as possible.

Start by making a minimal reproducible example using the reprex package:

install.packages("reprex")
library("reprex")

After loading the reprex package, copy some code to your clipboard that includes the library() functions, the process you used (ideally simplified), and the functions that are creating issues. Once the material is copied, you can use reprex() to format your example:

reprex()

For additional reprex pointers, check out the Get help! section of the tidyverse site.

Armed with your reprex, the next step is to figure out where to ask:

Before opening a new issue, be sure to search issues and pull requests to make sure the bug hasn't been reported and/or already fixed in the development version. By default, the search will be pre-populated with is:issue is:open. You can edit the qualifiers (e.g. is:pr, is:closed) as needed. For example, you'd simply remove is:open to search all issues in the repo, open or closed.

If you are in the right place, and need to file an issue, please review the contributing guidelines for this lesson.

Thanks for your help!

Credits

This document is adopted from @jennybc's Contribution document for the usethis package.



shaughnessyar/driftR documentation built on July 25, 2022, 8:32 a.m.