Skip to content

Improve contribution guide #464

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Oct 12, 2023
Merged

Improve contribution guide #464

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c152644
Add information on making bigger changes
jamesmbaazam Oct 3, 2023
7b304b8
Improve wording
jamesmbaazam Oct 3, 2023
5ec3b86
Bump up version
jamesmbaazam Oct 3, 2023
0763c6d
Add news item
jamesmbaazam Oct 3, 2023
4720823
Don't increment the dev version
jamesmbaazam Oct 4, 2023
517968b
Add a note on version increment
jamesmbaazam Oct 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Add information on making bigger changes
  • Loading branch information
@jamesmbaazam
jamesmbaazam committed Oct 3, 2023
commit c1526443383018a8f0a2a70a8cbdc475a603bb44
18 changes: 15 additions & 3 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,21 @@ You can find the `.R` file that generates the `.Rd` by reading the comment in th

## 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).
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.

## New features & Bugs

If you have an idea for a feature or have found a bug, please file an issue.
For bugs, illustrate them with a minimal [reprex](https://www.tidyverse.org/help/#reprex)
(this will also help you write a unit test, if needed).

## Vignettes

If you have an idea for a vignette, please file an issue with an outline of the vignette
to be discussed with the team first. Since the models in _EpiNow2_ have long run times
in most cases, we pre-compile the vignettes before merging. Please follow this guide
on [how to precompute vignettes or pkgdown articles](https://ropensci.org/blog/2019/12/08/precompute-vignettes/).

### Pull request process

Expand Down