diff --git a/.Rbuildignore b/.Rbuildignore index 93ce648..7ac04f7 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -16,3 +16,4 @@ ^cran-comments\.md$ ^pkgdown$ +^\.github$ diff --git a/.github/.gitignore b/.github/.gitignore new file mode 100644 index 0000000..2d19fc7 --- /dev/null +++ b/.github/.gitignore @@ -0,0 +1 @@ +*.html diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..a9496c1 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,46 @@ +# Contributing to tinter + +This outlines how to propose a change to tinter. + +## Fixing typos + +You can fix typos, spelling mistakes, or grammatical errors in the documentation directly using the GitHub web interface, as long as the changes are made in the _source_ file. +This generally means you'll need to edit [roxygen2 comments](https://roxygen2.r-lib.org/articles/roxygen2.html) in an `.R`, not a `.Rd` file. +You can find the `.R` file that generates the `.Rd` by reading the comment in the first line. + +## Bigger changes + +If you want to make a bigger change, it's a good idea to first file an issue and make sure someone from the team agrees that it’s needed. +If you’ve found a bug, please file an issue that illustrates the bug with a minimal +[reprex](https://www.tidyverse.org/help/#reprex) (this will also help you write a unit test, if needed). + +### Pull request process + +* Fork the package and clone onto your computer. If you haven't done this before, we recommend using `usethis::create_from_github("", fork = TRUE)`. + +* Install all development dependences with `devtools::install_dev_deps()`, and then make sure the package passes R CMD check by running `devtools::check()`. +If R CMD check doesn't pass cleanly, it's a good idea to ask for help before continuing. +* Create a Git branch for your pull request (PR). We recommend using `usethis::pr_init("brief-description-of-change")`. + +* Make your changes, commit to git, and then create a PR by running `usethis::pr_push()`, and following the prompts in your browser. +The title of your PR should briefly describe the change. +The body of your PR should contain `Fixes #issue-number`. + +* Begin commit or merge messages with `-` to indicate user facing changes that should be included in NEWS.md. +We will use [fledge](https://github.com/krlmlr/fledge) to automatically generate the NEWS.md file. + +### Code style + +* New code should follow the tidyverse [style guide](https://style.tidyverse.org). +You can use the [styler](https://CRAN.R-project.org/package=styler) package to apply these styles, but please don't restyle code that has nothing to do with your PR. + +* We use [roxygen2](https://cran.r-project.org/package=roxygen2), with [Markdown syntax](https://cran.r-project.org/web/packages/roxygen2/vignettes/rd-formatting.html), for documentation. + +* We use [testthat](https://cran.r-project.org/package=testthat) for unit tests. +Contributions with test cases included are easier to accept. + +## Code of Conduct + +Please note that the tinter project is released with a +[Contributor Code of Conduct](/.github/CODE_OF_CONDUCT.md). +By contributing to this project you agree to abide by its terms. diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md new file mode 100644 index 0000000..74d30a4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.md @@ -0,0 +1,17 @@ +--- +name: Bug report +about: Describe a bug you're experiencing +--- + +## The Bug + +Please briefly describe your problem and what output you expect. + +## A Reprex + +Please include a minimal reproducible example (AKA a reprex). +If you've never heard of a [reprex](http://reprex.tidyverse.org/) before, start by reading . + +```r +# insert reprex here +``` diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md new file mode 100644 index 0000000..5b1b592 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -0,0 +1,8 @@ +--- +name: Feature request +about: Suggest an idea for this project +--- + +## Your Idea + +Please briefly describe your idea. diff --git a/.github/SUPPORT.md b/.github/SUPPORT.md new file mode 100644 index 0000000..2d59c59 --- /dev/null +++ b/.github/SUPPORT.md @@ -0,0 +1,18 @@ +# Getting help with tinter + +Thanks for using tinter! +Before filing an issue, there are a few places to explore and pieces to put together to make the process as smooth as possible. + +## Make sure its new + +Before opening a new issue, be sure to [search issues and pull requests](https://github.com//issues) 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](https://help.github.com/articles/searching-issues-and-pull-requests/) (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. + +## Make a reprex + +Start by making a minimal **repr**oducible **ex**ample using the [reprex](https://reprex.tidyverse.org/) 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!](https://www.tidyverse.org/help/) section of the tidyverse site. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..a8bc60a --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,17 @@ +Thank you for taking the time to submit a pull request! + +To maximize the chances of acceptance: + +* The title of your PR should briefly describe the change. + +* The body of your PR should contain `Fixes #issue-number` (if relevant). + +* Commit/merge messages to be included in NEWS.md should begin with `-`. + +* Code should follow the tidyverse [style guide](https://style.tidyverse.org). + +* Documentation should use roxygen2, with Markdown syntax. + +* Contributions should include unit tests (using `testthat`). + +For more information see [Contributing](/.github/CONTRIBUTING.md).