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
Prev Previous commit
Next Next commit
Improve wording
  • Loading branch information
@jamesmbaazam
jamesmbaazam committed Oct 3, 2023
commit 7b304b8fffde37878ab8c362d8fb96cf05c6958e
34 changes: 23 additions & 11 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,30 +1,42 @@
# Contributing to EpiNow2

This outlines how to propose a change to EpiNow2.
This outlines how to propose a change to EpiNow2. In general, we accept contributions
in the form of issues and/or pull requests.

## Fixing typos
## Small changes

### Grammatical issues

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 of the `.Rd` file in the `/man` directory.

## Bigger changes
## Big 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.
someone from the team agrees that it’s needed. Any of the following counts as a big change:

### New features

You can suggest an idea for a new feature/enhancement. Please provide as much
detail of its use case as possible. As an example, see this extensive issue about [making the model outputs S3 classes](https://github.com/epiforecasts/EpiNow2/issues/451).

### Bugs

## New features & Bugs
If you have found a bug, ideally illustrate it with a minimal [reprex](https://www.tidyverse.org/help/#reprex)
(this will also help you write a unit test, if you opt to fix it yourself). Here is an [example of a bug report](https://github.com/epiforecasts/EpiNow2/issues/392).

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

## Vignettes
If you find an issue with existing vignettes or would like to help improve them, outline
the suggested changes in the submitted issue for discussion with the team. Use the various GitHub
markdown features to (cross)reference lines, highlight suggested deletions/additions, etc.

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
For new vignettes, please provide 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/).
Here is [an example where new pre-compiled vignettes](https://github.com/epiforecasts/EpiNow2/pull/458) were submitted.

### Pull request process

Expand Down