.github/SUPPORT.md

Getting help with simfinapi

Thanks for using simfinapi. 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. If you haven't heard of or used reprex before, you're in for a treat! Seriously, reprex will make all of your R-question-asking endeavors easier (which is a pretty insane ROI for the five to ten minutes it'll take you to learn what it's all about). 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 "File issues" paragraph from the tidyverse contributing guidelines.

Thanks for your help!



matthiasgomolka/simfinapi documentation built on April 22, 2024, 5:28 a.m.