Skip to content

Added developers instructions to install the package and run its tests #55

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
yulric merged 1 commit into from
Mar 10, 2025
Merged

Added developers instructions to install the package and run its tests #55

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
23 changes: 23 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,28 @@
# Contributing to recodeflow

## Installation

1. [Install R](https://www.r-project.org/)

This package uses R version 4.3.2. If you have another version of R installed
on your system, we recommend using [rig](https://github.com/r-lib/rig) which
allows you to install and manage multiple versions of R. Use the commands
`rig add 4.3.2` and `rig default 4.3.2` to install and use the required R
version.
2. Install dependencies

This package uses [renv](https://rstudio.github.io/renv/articles/renv.html)
to manage its dependencies. Start an R session within the project root and
renv should bootstrap itself. You can then run the command `renv::restore()`
to install the dependencies.

You should now be ready to start working on the package

## Running tests

[Install the dependencies](#Installation)

Run the command `devtools::test()` within the R session to run the tests.

## Filing an issue

Expand Down
Loading