This outlines how to propose a change to osfr.
To get started with osfr development you’ll need to generate a personal access token (PAT) on OSF’s testing server. The following steps will get you setup:
.Renviron file in the root of your project directory that defines the
OSF_SERVER environment variables. You can easily create or edit an existing
.Renviron file by running
usethis::edit_r_environ(scope = "project"). The end result should look like this:
OSF_PAT=<YOUR PAT GOES HERE> OSF_SERVER=test
Restart R to load your
.Renviron file or use
readRneviron(".Renviron"). Then load your local copy of osfr with
devtools::load_all() and verify that
osf_open(osf_retrieve_user("me")) opens your user profile on the
Once this is setup correctly, you should be able to run osfr’s tests without error (
You can also enable logging by defining
OSF_LOG to point to a logfile. For example:
This will log all API requests to
osfr.log for inspection.
Small typos or grammatical errors in documentation may be edited directly using the GitHub web interface, so long as the changes are made in the source file.
Before you make a substantial pull request, you should always file an issue and make sure someone from the team agrees that it’s a problem. If you’ve found a bug, create an associated issue and illustrate the bug with a minimal reprex.
READMEshould contain badges for any continuous integration services used by the package.
NEWS.mdbelow the current development version header describing the changes made followed by your GitHub username, and links to relevant issue(s)/PR(s).
make docs to:
make cleanto remove build/check files
make testto run unit tests
make tagto tag the last git commit with the current version