-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #24 from wjakethompson/joss-paper
JOSS paper
- Loading branch information
Showing
16 changed files
with
1,097 additions
and
8 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 |
---|---|---|
|
@@ -13,3 +13,4 @@ | |
^vignettes/articles$ | ||
^CRAN-SUBMISSION$ | ||
^revdep$ | ||
^CITATION\.cff$ |
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,46 @@ | ||
# Contributing to measr | ||
|
||
This outlines how to propose a change to measr. | ||
|
||
## Fixing typos | ||
|
||
You can fix typos, spelling mistakes, or grammatical errors in the documentation directly using the GitHub web interface, as long as the changes are made in the _source_ file. | ||
This generally means you'll need to edit [roxygen2 comments](https://roxygen2.r-lib.org/articles/roxygen2.html) in an `.R`, not a `.Rd` file. | ||
You can find the `.R` file that generates the `.Rd` by reading the comment in the first line. | ||
|
||
## Bigger changes | ||
|
||
If you want to make a bigger change, it's a good idea to first file an issue and make sure someone from the team agrees that it’s needed. | ||
If you’ve found a bug, please file an issue that illustrates the bug with a minimal | ||
[reprex](https://www.tidyverse.org/help/#reprex) (this will also help you write a unit test, if needed). | ||
See the tidyverse guide on [how to create a great issue](https://code-review.tidyverse.org/issues/) for more advice. | ||
|
||
### Pull request process | ||
|
||
* Fork the package and clone onto your computer. If you haven't done this before, we recommend using `usethis::create_from_github("wjakethompson/measr", fork = TRUE)`. | ||
|
||
* Install all development dependencies with `devtools::install_dev_deps()`, and then make sure the package passes R CMD check by running `devtools::check()`. | ||
If R CMD check doesn't pass cleanly, it's a good idea to ask for help before continuing. | ||
* Create a Git branch for your pull request (PR). We recommend using `usethis::pr_init("brief-description-of-change")`. | ||
|
||
* Make your changes, commit to git, and then create a PR by running `usethis::pr_push()`, and following the prompts in your browser. | ||
The title of your PR should briefly describe the change. | ||
The body of your PR should contain `Fixes #issue-number`. | ||
|
||
* For user-facing changes, add a bullet to the top of `NEWS.md` (i.e. just below the first header). Follow the style described in <https://style.tidyverse.org/news.html>. | ||
|
||
### Code style | ||
|
||
* New code should follow the tidyverse [style guide](https://style.tidyverse.org). | ||
You can use the [styler](https://CRAN.R-project.org/package=styler) package to apply these styles, but please don't restyle code that has nothing to do with your PR. | ||
|
||
* We use [roxygen2](https://cran.r-project.org/package=roxygen2), with [Markdown syntax](https://cran.r-project.org/web/packages/roxygen2/vignettes/rd-formatting.html), for documentation. | ||
|
||
* We use [testthat](https://cran.r-project.org/package=testthat) for unit tests. | ||
Contributions with test cases included are easier to accept. | ||
|
||
## Code of Conduct | ||
|
||
Please note that the measr project is released with a | ||
[Contributor Code of Conduct](CODE_OF_CONDUCT.md). By contributing to this | ||
project you agree to abide by its terms. |
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,55 @@ | ||
# Workflow derived from https://github.com/r-lib/actions/tree/master/examples | ||
# The action runs when: | ||
# - A new release is published | ||
# - The DESCRIPTION or inst/CITATION are modified | ||
# - Can be run manually | ||
# For customizing the triggers, visit https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows | ||
on: | ||
release: | ||
types: [published] | ||
push: | ||
branches: [master, main] | ||
paths: | ||
- DESCRIPTION | ||
- inst/CITATION | ||
workflow_dispatch: | ||
|
||
name: Update CITATION.cff | ||
|
||
jobs: | ||
update-citation-cff: | ||
runs-on: ubuntu-latest | ||
env: | ||
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} | ||
steps: | ||
- uses: actions/checkout@v3 | ||
- uses: r-lib/actions/setup-r@v2 | ||
- uses: r-lib/actions/setup-r-dependencies@v2 | ||
with: | ||
extra-packages: | | ||
any::cffr | ||
any::V8 | ||
- name: Update CITATION.cff | ||
run: | | ||
library(cffr) | ||
# Customize with your own code | ||
# See https://docs.ropensci.org/cffr/articles/cffr.html | ||
# Write your own keys | ||
mykeys <- list() | ||
# Create your CITATION.cff file | ||
cff_write(keys = mykeys) | ||
shell: Rscript {0} | ||
|
||
- name: Commit results | ||
run: | | ||
git config --local user.name "github-actions[bot]" | ||
git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com" | ||
git add CITATION.cff | ||
git commit -m 'Update CITATION.cff' || echo "No changes to commit" | ||
git push origin || echo "No changes to commit" |
Oops, something went wrong.