From 5bf7027fc161f7138d1ac36c6891e5424c616a87 Mon Sep 17 00:00:00 2001 From: Indrajeet Patil Date: Sun, 3 Nov 2024 18:45:55 +0100 Subject: [PATCH 01/11] Address feedback from reviewer-2 --- paper/paper.Rmd | 4 ++-- paper/paper.md | 11 +++++++---- 2 files changed, 9 insertions(+), 6 deletions(-) diff --git a/paper/paper.Rmd b/paper/paper.Rmd index e6f08cb0b..95e33c810 100644 --- a/paper/paper.Rmd +++ b/paper/paper.Rmd @@ -65,7 +65,7 @@ withr::local_options(list( # Statement of Need -A linter is a tool that analyzes code to identify potential errors, stylistic issues, or deviations from coding standards. It helps ensure consistency, readability, and best practices by flagging common mistakes, such as syntax errors, unused variables, or improper formatting. Linters are essential for improving code quality, preventing bugs, and maintaining a clean codebase, especially in collaborative development environments [@enwiki:1218663830]. `{lintr}` is an open-source package that provides linters for the R programming language, which is an interpreted, dynamically-typed programming language [@base2023], and is used by a wide range of researchers and data scientists. `{lintr}` can thus act as a valuable tool for R users to help improve the quality and reliability of their code. +In computer programming, "linting" is the process of analyzing the source code to identify possible programming and stylistic problems (https://en.wiktionary.org/wiki/linting) and a linter is a tool used for linting. A linter analyzes code to identify potential errors, stylistic issues, or deviations from coding standards. It helps ensure consistency, readability, and best practices by flagging common mistakes, such as syntax errors, unused variables, or improper formatting. Linters are essential for improving code quality, preventing bugs, and maintaining a clean codebase, especially in collaborative development environments [@enwiki:1218663830]. `{lintr}` is an open-source package that provides linters for the R programming language, which is an interpreted, dynamically-typed programming language [@base2023], and is used by a wide range of researchers and data scientists. `{lintr}` can thus act as a valuable tool for R users to help improve the quality and reliability of their code. # Features @@ -79,7 +79,7 @@ library(lintr) length(all_linters()) ``` -Naturally, we can't discuss all of them here. To see details about all available linters, we encourage readers to see . +Naturally, we can't discuss all of them here. To see the most up-to-date details about all the available linters, we encourage readers to visit . We will showcase one linter for each kind of common problem found in R code. diff --git a/paper/paper.md b/paper/paper.md index 27793ea75..b8111903d 100644 --- a/paper/paper.md +++ b/paper/paper.md @@ -1,6 +1,6 @@ --- title: "Static Code Analysis for R" -date: "2024-10-02" +date: "2024-11-03" tags: ["R", "linter", "tidyverse"] authors: - name: Jim Hester @@ -51,7 +51,10 @@ link-citations: true # Statement of Need -A linter is a tool that analyzes code to identify potential errors, +In computer programming, "linting" is the process of analyzing the +source code to identify possible programming and stylistic problems +() and a linter is a tool used +for linting. A linter analyzes code to identify potential errors, stylistic issues, or deviations from coding standards. It helps ensure consistency, readability, and best practices by flagging common mistakes, such as syntax errors, unused variables, or improper @@ -86,8 +89,8 @@ length(all_linters()) #> [1] 113 ``` -Naturally, we can't discuss all of them here. To see details about all -available linters, we encourage readers to see +Naturally, we can't discuss all of them here. To see the most up-to-date +details about all the available linters, we encourage readers to visit . We will showcase one linter for each kind of common problem found in R From 33e4523ff9fc3c1ab2328407e6e094d1bad2141a Mon Sep 17 00:00:00 2001 From: Indrajeet Patil Date: Thu, 28 Nov 2024 19:14:41 +0100 Subject: [PATCH 02/11] Create CONTRIBUTING.md --- .github/CONTRIBUTING.md | 51 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 .github/CONTRIBUTING.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 000000000..6983bbd64 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,51 @@ +# Contributing to `{lintr}` + +This outlines how to propose a change to `{lintr}`. +For a detailed discussion on contributing to this, r-lib, and other tidyverse packages, please see the [development contributing guide](https://rstd.io/tidy-contrib) and our [code review principles](https://code-review.tidyverse.org/). + +## 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). +See our guide on [how to create a great issue](https://code-review.tidyverse.org/issues/) for more advice. + +### Adding a new linter + +If you wish to contribute a new linter, the [Creating new linters](https://lintr.r-lib.org/articles/creating_linters.html) article serves as a comprehensive guide. + +### 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("r-lib/lintr", fork = TRUE)`. + +* Install all development dependencies 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`. + +* For user-facing changes, add a bullet to the top of `NEWS.md` (i.e. just below the first header). Follow the style described in . + +### 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 lintr project is released with a +[Contributor Code of Conduct](CODE_OF_CONDUCT.md). By contributing to this +project you agree to abide by its terms. From b8195c2c9da8a79d8851f3ca713fa3a3e9b7181d Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Sun, 1 Dec 2024 21:39:09 -0800 Subject: [PATCH 03/11] Add a note about avoiding 'main' --- .github/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 6983bbd64..04a296858 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -26,7 +26,7 @@ If you wish to contribute a new linter, the [Creating new linters](https://lintr * Install all development dependencies 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")`. +* Create a Git branch for your pull request (PR). We recommend using `usethis::pr_init("brief-description-of-change")`. At a minimum, please avoid submitting PRs from your fork's `main` branch` as this can make the review process more complicated. * 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. From f515956008717e59604d8a7fc1fc55dbfea01b13 Mon Sep 17 00:00:00 2001 From: Indrajeet Patil Date: Mon, 2 Dec 2024 07:05:42 +0100 Subject: [PATCH 04/11] Update .github/CONTRIBUTING.md Co-authored-by: Michael Chirico --- .github/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 04a296858..63104b018 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -32,7 +32,7 @@ If you wish to contribute a new linter, the [Creating new linters](https://lintr The title of your PR should briefly describe the change. The body of your PR should contain `Fixes #issue-number`. -* For user-facing changes, add a bullet to the top of `NEWS.md` (i.e. just below the first header). Follow the style described in . +* For user-facing changes, add a bullet appropriately in the top section of `NEWS.md` (i.e. below the first header). Follow the style described in . ### Code style From 12b6c361170d339327a2997910a952d4036a026d Mon Sep 17 00:00:00 2001 From: Indrajeet Patil Date: Mon, 2 Dec 2024 07:06:06 +0100 Subject: [PATCH 05/11] Update .github/CONTRIBUTING.md Co-authored-by: Michael Chirico --- .github/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 63104b018..07a2f7068 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -37,7 +37,7 @@ If you wish to contribute a new linter, the [Creating new linters](https://lintr ### 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. + You can use the [styler](https://CRAN.R-project.org/package=styler) package to apply these styles. * 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. From ba61bb3d9bbea668b1156d4989db2b988d2d0ade Mon Sep 17 00:00:00 2001 From: Indrajeet Patil Date: Mon, 2 Dec 2024 07:21:35 +0100 Subject: [PATCH 06/11] Remove unnecessary newlines in contributing.md --- .github/CONTRIBUTING.md | 32 ++++++++++---------------------- 1 file changed, 10 insertions(+), 22 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 07a2f7068..c68a67e1e 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,20 +1,14 @@ # Contributing to `{lintr}` -This outlines how to propose a change to `{lintr}`. -For a detailed discussion on contributing to this, r-lib, and other tidyverse packages, please see the [development contributing guide](https://rstd.io/tidy-contrib) and our [code review principles](https://code-review.tidyverse.org/). +This outlines how to propose a change to `{lintr}`. For a detailed discussion on contributing to this, r-lib, and other tidyverse packages, please see the [development contributing guide](https://rstd.io/tidy-contrib) and our [code review principles](https://code-review.tidyverse.org/). ## 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. +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). -See our guide on [how to create a great issue](https://code-review.tidyverse.org/issues/) for more advice. +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). See the tidyverse guide on [how to create a great issue](https://code-review.tidyverse.org/issues/) for more advice. ### Adding a new linter @@ -24,28 +18,22 @@ If you wish to contribute a new linter, the [Creating new linters](https://lintr * Fork the package and clone onto your computer. If you haven't done this before, we recommend using `usethis::create_from_github("r-lib/lintr", fork = TRUE)`. -* Install all development dependencies 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. +* Install all development dependencies 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")`. At a minimum, please avoid submitting PRs from your fork's `main` branch` as this can make the review process more complicated. -* 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`. +* Make your changes, commit them to Git, and create a PR using `usethis::pr_push()`. Follow the prompts in your browser to complete the process. Use a concise title for your PR that summarizes the change, and include `Fixes #issue-number` in the PR description. * For user-facing changes, add a bullet appropriately in the top section of `NEWS.md` (i.e. below the first header). Follow the style described in . ### 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. +* 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. -* 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 [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. +* 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 lintr project is released with a -[Contributor Code of Conduct](CODE_OF_CONDUCT.md). By contributing to this -project you agree to abide by its terms. +Please note that the lintr project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By contributing to this project you agree to abide by its terms. From 170df4771218c09d4f3fe0fa243f0f3aacef6b4e Mon Sep 17 00:00:00 2001 From: Indrajeet Patil Date: Mon, 2 Dec 2024 07:21:48 +0100 Subject: [PATCH 07/11] add cite to wiki page on linting --- paper/paper.Rmd | 2 +- paper/paper.bib | 12 ++++++++++-- paper/paper.md | 26 +++++++++++++------------- 3 files changed, 24 insertions(+), 16 deletions(-) diff --git a/paper/paper.Rmd b/paper/paper.Rmd index a7f9b7117..072cb1ef5 100644 --- a/paper/paper.Rmd +++ b/paper/paper.Rmd @@ -66,7 +66,7 @@ withr::local_options(list( # Statement of Need -In computer programming, "linting" is the process of analyzing the source code to identify possible programming and stylistic problems (https://en.wiktionary.org/wiki/linting) and a linter is a tool used for linting. A linter analyzes code to identify potential errors, stylistic issues, or deviations from coding standards. It helps ensure consistency, readability, and best practices by flagging common mistakes, such as syntax errors, unused variables, or improper formatting. Linters are essential for improving code quality, preventing bugs, and maintaining a clean codebase, especially in collaborative development environments [@enwiki:1218663830]. `{lintr}` is an open-source package that provides linters for the R programming language, which is an interpreted, dynamically-typed programming language [@base2023], and is used by a wide range of researchers and data scientists. `{lintr}` can thus act as a valuable tool for R users to help improve the quality and reliability of their code. +In computer programming, "linting" is the process of analyzing the source code to identify possible programming and stylistic problems [@enwiki:1260589258] and a linter is a tool used for linting. A linter analyzes code to identify potential errors, stylistic issues, or deviations from coding standards. It helps ensure consistency, readability, and best practices by flagging common mistakes, such as syntax errors, unused variables, or improper formatting. Linters are essential for improving code quality, preventing bugs, and maintaining a clean codebase, especially in collaborative development environments [@enwiki:1218663830]. `{lintr}` is an open-source package that provides linters for the R programming language, which is an interpreted, dynamically-typed programming language [@base2023], and is used by a wide range of researchers and data scientists. `{lintr}` can thus act as a valuable tool for R users to help improve the quality and reliability of their code. # Features diff --git a/paper/paper.bib b/paper/paper.bib index 329f7c403..5b8e8db9e 100644 --- a/paper/paper.bib +++ b/paper/paper.bib @@ -32,12 +32,20 @@ @book{mcconnell2004code publisher={Pearson Education} } -@misc{ enwiki:1218663830, +@misc{enwiki:1218663830, author = "{Wikipedia contributors}", title = "Static program analysis --- {Wikipedia}{,} The Free Encyclopedia", year = "2024", url = "https://en.wikipedia.org/w/index.php?title=Static_program_analysis&oldid=1218663830", - note = "[Online; accessed 7-May-2024]" + note = "[Online; accessed 2-December-2024]" + } + +@misc{enwiki:1260589258, + author = "{Wikipedia contributors}", + title = "Lint (software) --- {Wikipedia}{,} The Free Encyclopedia", + year = "2024", + url = "https://en.wikipedia.org/w/index.php?title=Lint_(software)&oldid=1260589258", + note = "[Online; accessed 2-December-2024]" } @Manual{Tierney2024, diff --git a/paper/paper.md b/paper/paper.md index 994d16e53..c7a35d658 100644 --- a/paper/paper.md +++ b/paper/paper.md @@ -53,19 +53,19 @@ link-citations: true In computer programming, "linting" is the process of analyzing the source code to identify possible programming and stylistic problems -() and a linter is a tool used -for linting. A linter analyzes code to identify potential errors, -stylistic issues, or deviations from coding standards. It helps ensure -consistency, readability, and best practices by flagging common -mistakes, such as syntax errors, unused variables, or improper -formatting. Linters are essential for improving code quality, preventing -bugs, and maintaining a clean codebase, especially in collaborative -development environments [@enwiki:1218663830]. `{lintr}` is an -open-source package that provides linters for the R programming -language, which is an interpreted, dynamically-typed programming -language [@base2023], and is used by a wide range of researchers and -data scientists. `{lintr}` can thus act as a valuable tool for R users -to help improve the quality and reliability of their code. +[@enwiki:1260589258] and a linter is a tool used for linting. A linter +analyzes code to identify potential errors, stylistic issues, or +deviations from coding standards. It helps ensure consistency, +readability, and best practices by flagging common mistakes, such as +syntax errors, unused variables, or improper formatting. Linters are +essential for improving code quality, preventing bugs, and maintaining a +clean codebase, especially in collaborative development environments +[@enwiki:1218663830]. `{lintr}` is an open-source package that provides +linters for the R programming language, which is an interpreted, +dynamically-typed programming language [@base2023], and is used by a +wide range of researchers and data scientists. `{lintr}` can thus act as +a valuable tool for R users to help improve the quality and reliability +of their code. # Features From 40bcea51d02b2245fc9a1e14742b228eed036e2a Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Sun, 1 Dec 2024 22:26:38 -0800 Subject: [PATCH 08/11] emphasize why 'Fixes #' in description --- .github/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index c68a67e1e..b91fe2e49 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -22,7 +22,7 @@ If you wish to contribute a new linter, the [Creating new linters](https://lintr * Create a Git branch for your pull request (PR). We recommend using `usethis::pr_init("brief-description-of-change")`. At a minimum, please avoid submitting PRs from your fork's `main` branch` as this can make the review process more complicated. -* Make your changes, commit them to Git, and create a PR using `usethis::pr_push()`. Follow the prompts in your browser to complete the process. Use a concise title for your PR that summarizes the change, and include `Fixes #issue-number` in the PR description. +* Make your changes, commit them to Git, and create a PR using `usethis::pr_push()`. Follow the prompts in your browser to complete the process. Use a concise title for your PR that summarizes the change, and include `Fixes #issue-number` in the PR _description_. Doing so will automatically close the linked issue when the PR is merged. * For user-facing changes, add a bullet appropriately in the top section of `NEWS.md` (i.e. below the first header). Follow the style described in . From 6ad8769628dde3bec6cda6d7ca15437ee3236048 Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Sun, 1 Dec 2024 22:28:22 -0800 Subject: [PATCH 09/11] Add note about extended Descriptions when needed, and hint at chains. --- .github/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index b91fe2e49..65e89374c 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -22,7 +22,7 @@ If you wish to contribute a new linter, the [Creating new linters](https://lintr * Create a Git branch for your pull request (PR). We recommend using `usethis::pr_init("brief-description-of-change")`. At a minimum, please avoid submitting PRs from your fork's `main` branch` as this can make the review process more complicated. -* Make your changes, commit them to Git, and create a PR using `usethis::pr_push()`. Follow the prompts in your browser to complete the process. Use a concise title for your PR that summarizes the change, and include `Fixes #issue-number` in the PR _description_. Doing so will automatically close the linked issue when the PR is merged. +* Make your changes, commit them to Git, and create a PR using `usethis::pr_push()`. Follow the prompts in your browser to complete the process. Use a concise title for your PR that summarizes the change, and include `Fixes #issue-number` in the PR _description_. Doing so will automatically close the linked issue when the PR is merged. For complicated changes, add a textual overview of what your PR does in the description. Consider breaking up large PRs into a chain of more digestible+focused smaller PRs. * For user-facing changes, add a bullet appropriately in the top section of `NEWS.md` (i.e. below the first header). Follow the style described in . From 0eee980e2053349a2f5a31ee9523aa5208dae6cd Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Sun, 1 Dec 2024 22:29:46 -0800 Subject: [PATCH 10/11] clarify the audience of NEWS entries --- .github/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 65e89374c..b5d9e6b1f 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -24,7 +24,7 @@ If you wish to contribute a new linter, the [Creating new linters](https://lintr * Make your changes, commit them to Git, and create a PR using `usethis::pr_push()`. Follow the prompts in your browser to complete the process. Use a concise title for your PR that summarizes the change, and include `Fixes #issue-number` in the PR _description_. Doing so will automatically close the linked issue when the PR is merged. For complicated changes, add a textual overview of what your PR does in the description. Consider breaking up large PRs into a chain of more digestible+focused smaller PRs. -* For user-facing changes, add a bullet appropriately in the top section of `NEWS.md` (i.e. below the first header). Follow the style described in . +* For user-facing changes, add a bullet appropriately in the top section of `NEWS.md` (i.e. below the first header). Follow the style described in . Your audience for NEWS items is a package user, i.e., _not_ a package developer. ### Code style From 6c915a9f089be56a8419c7f1e2f1303abd35746c Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Sun, 1 Dec 2024 22:30:53 -0800 Subject: [PATCH 11/11] tweak --- .github/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index b5d9e6b1f..10289cd35 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -24,7 +24,7 @@ If you wish to contribute a new linter, the [Creating new linters](https://lintr * Make your changes, commit them to Git, and create a PR using `usethis::pr_push()`. Follow the prompts in your browser to complete the process. Use a concise title for your PR that summarizes the change, and include `Fixes #issue-number` in the PR _description_. Doing so will automatically close the linked issue when the PR is merged. For complicated changes, add a textual overview of what your PR does in the description. Consider breaking up large PRs into a chain of more digestible+focused smaller PRs. -* For user-facing changes, add a bullet appropriately in the top section of `NEWS.md` (i.e. below the first header). Follow the style described in . Your audience for NEWS items is a package user, i.e., _not_ a package developer. +* For user-facing changes, add a bullet appropriately in the top section of `NEWS.md` (i.e. below the first header). Follow the style described in . Most importantly, your audience for NEWS items is a package user, i.e., _not_ a package developer. ### Code style