-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
18 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# Contribution guidelines | ||
|
||
After making changes, you'll need to take the following steps: | ||
|
||
- Rebuild roxygen: `Rscript -e "devtools::document()"` | ||
- Run R CMD CHECK: `Rscript -e 'devtools::check()'` | ||
- Build documentation website: `Rscript -e 'pkgdown::build_site_github_pages(install=TRUE)'` | ||
- Push the `/docs` folder to the `gh-pages` branch of the repo to update the documentation website | ||
|
||
## Making a release | ||
|
||
- bump the version according to semver.org | ||
- make a release on GitHub | ||
|
||
After making the release, bump the version to x.x.x.9000 to mark it as a development version |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters