diff --git a/README.Rmd b/README.Rmd index 674afdf..4b98295 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 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. @@ -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 +
diff --git a/README.md b/README.md index fdc4afe..9ab6434 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 it, 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 @@ -73,6 +77,8 @@ All contributions to this project are gratefully acknowledged using the following the [all-contributors](https://allcontributors.org) specification. Contributions of any kind are welcome! +### Code + @@ -93,6 +99,32 @@ specification. Contributions of any kind are welcome! rivaquiroga + + + + +
+ + + +
+sndaba +
+ +### Issues + + + + + + +
+ + + +
+jyoti-bhogal +