SUPPORT.md

Getting help with lintr

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

Making a reproducible example

Start by making a minimal reproducible example using the reprex package. For how to use reprex effectivly, check out the Get help! section of the tidyverse site.

The most useful function to create reprexes for {lintr} issues is lint(). You can include code that doesn't lint as expected with the linter in question. For example,

library(lintr)

lint(
  text = "x = 1",
  linters = assignment_linter()
)

If code in question contains characters that need to be escaped, consider using raw strings instead to save yourself some headache figuring out the multiple levels of escapes.

Asking for help

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

If it's a clarification question (e.g. you don't know how to exclude certain files from lint workflow), start with community.rstudio.com, and/or StackOverflow. There are more people there to answer questions.

Filing an issue

If it's a bug, you can create an issue with a reprex.

If it's a false positive or false negative lint, you can either create an issue with a reprex in {lintr} repository, or discuss the underlying style guide itself in the respective repository.

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.

Thanks for your help!