Skip to content

Commit bf21495

Browse files
jamesmbaazamsbfnk
andauthored
Amend contribution guide (#406)
Co-authored-by: Sebastian Funk <sebastian.funk@lshtm.ac.uk>
1 parent 0c1aef7 commit bf21495

File tree

2 files changed

+20
-1
lines changed

2 files changed

+20
-1
lines changed

.github/CONTRIBUTING.md

+15-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This outlines how to propose a change to EpiNow2.
66

77
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.
88
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.
9-
You can find the `.R` file that generates the `.Rd` by reading the comment in the first line.
9+
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.
1010

1111
## Bigger changes
1212

@@ -40,6 +40,20 @@ precommit::use_precommit()
4040

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

43+
#### What happens after submitting a PR?
44+
45+
* PRs are reviewed by the team before they are merged. The review process only begins after the continuous integration checks, which have to be manually triggered by a maintainer for first-time contributors, have passed.
46+
* 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.
47+
48+
* Usually, all the review conversations occur under the PR. The reviewer merges the PR when every issue has been resolved. Please use the "Resolve conversation" functionality in the GitHub web interface to indicate when a specific issue has been adressed, responding with a commit pointing to the change made where applicable.
49+
50+
* 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 (using the `--force` option, that is, `git push -f`, if required).
51+
52+
* A number of issues can cause the Github checks to fail. It can be helpful to safeguard against them by doing the following:
53+
* Check that there are no linting issues by running `lintr::lint_package()`.
54+
* Run `devtoools::check()` to check for wider package issues like mismatching documentation, etc. (this currently requires a fair bit of time/computation).
55+
* (Optional) Turn on continuous integration with Github Actions on your forked repository.
56+
4357
### Code style
4458

4559
* New code should follow the tidyverse [style guide](https://style.tidyverse.org).

inst/WORDLIST

+5
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ Nowcasts
3939
ORCID
4040
PLoS
4141
PMF
42+
PRs
4243
Poisson
4344
Quilty
4445
Riutort
@@ -101,6 +102,8 @@ poisson
101102
progressr
102103
rds
103104
realland
105+
reprex
106+
roxygen
104107
rstan
105108
runtimes
106109
sd
@@ -110,7 +113,9 @@ st
110113
stan
111114
stanfit
112115
testland
116+
testthat
113117
tibbles
118+
tidyverse
114119
timelimit
115120
underreporting
116121
varphi

0 commit comments

Comments
 (0)