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_PAT
and 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
.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 test.osf.io
domain.Once this is setup correctly, you should be able to run osfr's tests without error (devtools::test()
).
You can also enable logging by defining OSF_LOG
to point to a logfile. For example:
OSF_PAT=osfr.log
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.
.R
file below R/
..Rd
file below man/
.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.
README
should contain badges for any continuous integration services used
by the package.NEWS.md
below the
current development version header describing the changes made followed by your
GitHub username, and links to relevant issue(s)/PR(s).Makefile
Run make docs
to:
rebuild README.md
from README.Rmd
regenerate the precomputed vignette getting_started.Rmd
from getting_started.Rmd.orig
rebuild the vignettes
rebuild package documentation
Run make
to
perform all of the documentation steps noted above
build the package
* check the package as CRAN but without running tests (this is temporary until mock tests are implemented)
Helpers:
make clean
to remove build/check filesmake test
to run unit testsmake check
to run R CMD check
on the packagemake revdep
to run reverse dependency checksmake tag
to tag the last git commit with the current versionAdd the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.