Skip to content

Add doc to precommit without permission #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 15, 2025
Merged

Add doc to precommit without permission #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,16 @@ You can install the development version of glossary from [GitHub](https://github
pak::pak("r-devel/glossary")
```

## using pre commit without repo permissions

- fork the repo and clone it locally
- install.packages("devtools")
- In a separate terminal (not R studio terminal), run `pip3 install pre-commit --user` (on windows)
- install.packages("precommit")
- On R studio, run `precommit::use_precommit()` (only once in a repo)



## Example

This is a basic example which shows you how to solve a common problem:
Expand Down
24 changes: 22 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,15 @@ You can install the development version of glossary from
pak::pak("r-devel/glossary")
```

## using pre commit without repo permissions

- fork the repo and clone it locally
- install.packages(“devtools”)
- In a separate terminal (not R studio terminal), run
`pip3 install pre-commit --user` (on windows)
- install.packages(“precommit”)
- On R studio, run `precommit::use_precommit()` (only once in a repo)

## Example

This is a basic example which shows you how to solve a common problem:
Expand All @@ -38,32 +47,43 @@ library(glossary)

## Contributors


<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->

<!-- prettier-ignore-start -->

<!-- markdownlint-disable -->

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!

<table>

<tr>

<td align="center">

<a href="https://github.com/SaranjeetKaur">
<img src="https://avatars.githubusercontent.com/u/28556616?v=4" width="100px;" alt=""/>
</a><br>
<a href="https://github.com/r-devel/glossary/commits?author=SaranjeetKaur">SaranjeetKaur</a>
</td>

<td align="center">

<a href="https://github.com/rivaquiroga">
<img src="https://avatars.githubusercontent.com/u/31421616?v=4" width="100px;" alt=""/>
</a><br>
<a href="https://github.com/r-devel/glossary/commits?author=rivaquiroga">rivaquiroga</a>
</td>

</tr>

</table>

<!-- markdownlint-enable -->

<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->
9 changes: 9 additions & 0 deletions inst/WORDLIST
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,17 @@
allcontributors
aut
Bhogal
CMD
cre
Dev
devtools
http
Kaur
ORCID
pre
precommit
repo
Roxygen
RoxygenNote
RSE
Saranjeet