Conversation
WalkthroughTwo new files are added to the Changes
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Fix all issues with AI agents
In @.github/CONTRIBUTING.md:
- Line 68: Update the email link text in the CONTRIBUTING content so it uses a
proper mailto: URI (change the href that currently reads
"joshua.lambert@lshtm.ac.uk" to "mailto:joshua.lambert@lshtm.ac.uk") so the
address is opened in email clients instead of being treated as a relative path;
locate the sentence containing "You can reach out through
[email](joshua.lambert@lshtm.ac.uk)" and replace the href accordingly.
- Line 3: Edit the opening lines so the first sentence is explicit and the
second uses correct grammar: change "This outlines how to propose a change to
ringbp." to "This document outlines how to propose a change to ringbp." and
replace "All contributions are welcomed." with "All contributions are welcome."
— update the two phrases in the CONTRIBUTING.md opening paragraph accordingly.
- Around line 49-51: The sentence in CONTRIBUTING.md repeats "asked to"
awkwardly; update the second occurrence so it reads naturally (e.g., change
"Please do not do this unless you're asked to." to "Please do not do this unless
you're asked." or "Please do not do this unless you're asked to do so.") so the
sentence is grammatically smooth.
- Around line 38-47: Update the text to correct casing and a typo: change any
instance of "Github" to "GitHub" and fix the tooling name "devtoools" to
"devtools" (the lines mentioning "GitHub Actions" and the bullet referencing
"devtoools::check()" should be updated accordingly); ensure the phrasing around
enabling CI and the command "devtools::check()" reflects the corrected name.
pearsonca
left a comment
There was a problem hiding this comment.
Looks fine to me. Made some minor suggestions.
Co-authored-by: Carl A. B. Pearson <pearsonca@users.noreply.github.com>
…/ringbp into add-contributing-md
|
I've opened issue #203 which relates to this PR. We can address it in this PR or wait until a subsequent PR if we aren't sure how best to resolve. |
This PR addresses #109 by adding a
CONTRIBUTING.mdfile to the package. The defaultCONTRIBUTING.mdfile was added usingusethis::use_tidy_contributing()and edited with sections adapted from theCONTRIBTING.mdof {EpiNow2} and Epiverse-TRACE.The styling guide for
NEWS.mdbullets is included, resolving #109.The
CONTRIBUTING.mdand the epiforecastsCODE_OF_CONDUCT.mdare added to theREADME.This PR also addresses #203 by linking to the development team in the
DESCRIPTIONfile in theCONTRIBUTING.md.Summary by CodeRabbit
Release Notes
Documentation
Chores
✏️ Tip: You can customize this high-level summary in your review settings.