From 6b18f5ddee9b847b781aaaea8b2364266883b965 Mon Sep 17 00:00:00 2001 From: Saranjeet Kaur Date: Mon, 15 Sep 2025 10:33:37 +0100 Subject: [PATCH 1/3] update readme --- README.Rmd | 27 +++++++++++++++++++++++++++ README.md | 38 ++++++++++++++++++++++++++------------ 2 files changed, 53 insertions(+), 12 deletions(-) diff --git a/README.Rmd b/README.Rmd index 674afdf..a83d942 100644 --- a/README.Rmd +++ b/README.Rmd @@ -41,6 +41,7 @@ install.packages("precommit") ``` - Run `precommit::use_precommit()` in the console. +- Once precommit is installed, each time you run `git commit`, the precommit hooks will run automatically. If any of the checks fail, you will need to fix the issues before you can successfully commit your changes. ## Example @@ -54,12 +55,15 @@ library(glossary) ## Contributors + All contributions to this project are gratefully acknowledged using the [`allcontributors` package](https://github.com/ropensci/allcontributors) following the [all-contributors](https://allcontributors.org) specification. Contributions of any kind are welcome! +### Code + @@ -75,6 +79,28 @@ All contributions to this project are gratefully acknowledged using the [`allcon
rivaquiroga + + + +
+ + +
+sndaba +
+ + +### Issues + + + + +
+ + +
+jyoti-bhogal +
@@ -82,3 +108,4 @@ All contributions to this project are gratefully acknowledged using the [`allcon + diff --git a/README.md b/README.md index fdc4afe..d83c8c3 100644 --- a/README.md +++ b/README.md @@ -62,43 +62,57 @@ library(glossary) ## Contributors - + - -All contributions to this project are gratefully acknowledged using the -[`allcontributors` package](https://github.com/ropensci/allcontributors) -following the [all-contributors](https://allcontributors.org) -specification. Contributions of any kind are welcome! +All contributions to this project are gratefully acknowledged using the [`allcontributors` package](https://github.com/ropensci/allcontributors) following the [all-contributors](https://allcontributors.org) specification. Contributions of any kind are welcome! + +### Code - - + + +
-
SaranjeetKaur 		-
rivaquiroga 		+ + +
+sndaba +
+ + +### Issues + + + + +
+ + +
+jyoti-bhogal +
- - + From b5d552bf62b4fb6b39e4f625587e637deba6180f Mon Sep 17 00:00:00 2001 From: Saranjeet Kaur Date: Mon, 15 Sep 2025 10:38:35 +0100 Subject: [PATCH 2/3] update readme --- README.Rmd | 4 ++-- README.md | 30 ++++++++++++++++++++++++------ 2 files changed, 26 insertions(+), 8 deletions(-) diff --git a/README.Rmd b/README.Rmd index a83d942..c342780 100644 --- a/README.Rmd +++ b/README.Rmd @@ -21,9 +21,9 @@ You can install the development version of glossary from [GitHub](https://github pak::pak("r-devel/glossary") ``` -## Using precommit when contributing +## Using pre-commit when contributing -This repository uses precommit. To install and run the same, follow the steps below: +This repository uses pre-commit. To install and run the same, follow the steps below: - In an external terminal run `pip3 install pre-commit --user` (for Windows) or `brew install pre-commit` (for macOS). - Based on the level of permissions you have, either directly clone this repository or clone a fork of this repository to a local directory. diff --git a/README.md b/README.md index d83c8c3..44a451c 100644 --- a/README.md +++ b/README.md @@ -27,9 +27,9 @@ You can install the development version of glossary from pak::pak("r-devel/glossary") ``` -## Using precommit when contributing +## Using pre-commit when contributing -This repository uses precommit. To install and run the same, follow the +This repository uses pre-commit. To install and run the same, follow the steps below: - In an external terminal run `pip3 install pre-commit --user` (for @@ -50,6 +50,10 @@ install.packages("precommit") ``` - Run `precommit::use_precommit()` in the console. +- Once precommit is installed, each time you run `git commit`, the + precommit hooks will run automatically. If any of the checks fail, you + will need to fix the issues before you can successfully commit your + changes. ## Example @@ -62,57 +66,71 @@ library(glossary) ## Contributors - + + -All contributions to this project are gratefully acknowledged using the [`allcontributors` package](https://github.com/ropensci/allcontributors) following the [all-contributors](https://allcontributors.org) specification. Contributions of any kind are welcome! +All contributions to this project are gratefully acknowledged using the +[`allcontributors` package](https://github.com/ropensci/allcontributors) +following the [all-contributors](https://allcontributors.org) +specification. Contributions of any kind are welcome! ### Code + + + +
+
SaranjeetKaur 		+
rivaquiroga 		+
sndaba
- ### Issues + +
+
jyoti-bhogal
+ - + From 9ae91c289d8e76955c7e62a9db329f284b464260 Mon Sep 17 00:00:00 2001 From: Saranjeet Kaur Date: Mon, 15 Sep 2025 10:42:31 +0100 Subject: [PATCH 3/3] update readme --- README.Rmd | 3 +-- README.md | 2 +- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/README.Rmd b/README.Rmd index c342780..4b98295 100644 --- a/README.Rmd +++ b/README.Rmd @@ -23,7 +23,7 @@ pak::pak("r-devel/glossary") ## Using pre-commit when contributing -This repository uses pre-commit. To install and run the same, follow the steps below: +This repository uses pre-commit. To install and run the it, follow the steps below: - In an external terminal run `pip3 install pre-commit --user` (for Windows) or `brew install pre-commit` (for macOS). - Based on the level of permissions you have, either directly clone this repository or clone a fork of this repository to a local directory. @@ -108,4 +108,3 @@ All contributions to this project are gratefully acknowledged using the [`allcon - diff --git a/README.md b/README.md index 44a451c..9ab6434 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ pak::pak("r-devel/glossary") ## Using pre-commit when contributing -This repository uses pre-commit. To install and run the same, follow the +This repository uses pre-commit. To install and run the it, follow the steps below: - In an external terminal run `pip3 install pre-commit --user` (for