Skip to content

Commit

Permalink
Merge 0b8ecfd into 0c1aef7
Browse files Browse the repository at this point in the history
  • Loading branch information
jamesmbaazam authored Jun 2, 2023
2 parents 0c1aef7 + 0b8ecfd commit d2cd1cd
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 1 deletion.
16 changes: 15 additions & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This outlines how to propose a change to EpiNow2.

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.
You can find the `.R` file that generates the `.Rd` by reading the comment in the first line of the `.Rd` file in the `/man` directory.

## Bigger changes

Expand Down Expand Up @@ -40,6 +40,20 @@ precommit::use_precommit()

* 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>.

#### What happens after submitting a PR?

* PRs are reviewed by the team before they are merged. The review process only begins after the continuous integration checks, which are manually triggered by the maintainer, have passed.

* The Github Actions checks currently take a while (about an hour), so it might be helpful to "watch" the repository and check your email for a notification when it's all done.

* Usually, all the review conversations occur under the PR. The reviewer merges the PR when every issue has been resolved. It is good practice to response to each raised conversation with a commit pointing to the change made to fix the issue.

* When a PR is ready to be merged, you may be asked to [rebase](https://www.atlassian.com/git/tutorials/merging-vs-rebasing) on the `main` branch. You can do this by checking out your branch and running `git rebase main`. If it is successful, your commits will be placed on top of the commit history of `main` in preparation for a merge. A rebase might result in some merge conflicts. Make sure that they are resolved, then push your changes to your branch again.

* A number of issues can cause the Github checks to fail. It might be helpful to safeguard against them by doing the following:
* Check that there are no linting issues by running `lintr::lint_package()`.
* Run `devtoools::check()` to check for wider package issues like mismatching documentation, e.t.c.
* (Optional) Turn on continuous integration with Github Actions on your forked repository.
### Code style

* New code should follow the tidyverse [style guide](https://style.tidyverse.org).
Expand Down
5 changes: 5 additions & 0 deletions inst/WORDLIST
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ Nowcasts
ORCID
PLoS
PMF
PRs
Poisson
Quilty
Riutort
Expand Down Expand Up @@ -101,6 +102,8 @@ poisson
progressr
rds
realland
reprex
roxygen
rstan
runtimes
sd
Expand All @@ -110,7 +113,9 @@ st
stan
stanfit
testland
testthat
tibbles
tidyverse
timelimit
underreporting
varphi
Expand Down

0 comments on commit d2cd1cd

Please sign in to comment.