Skip to content
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.

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

Explain precompiled vignettes in contribution guide #463

Closed
sbfnk opened this issue Oct 3, 2023 · 2 comments · Fixed by #464
Closed

Explain precompiled vignettes in contribution guide #463

sbfnk opened this issue Oct 3, 2023 · 2 comments · Fixed by #464

Comments

@sbfnk
Copy link
Contributor

sbfnk commented Oct 3, 2023

          it should likely be added to the contributing guide if it isn't already (I think it isn't)

Originally posted by @seabbs in #458 (comment)

@jamesmbaazam
Copy link
Contributor

I currently don't see where this would go based in the guide. I think the section on "bigger" changes can be structured as:

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

+ ## 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 precompile 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/).

@sbfnk
Copy link
Contributor Author

sbfnk commented Oct 3, 2023

That sounds good to me - would be great to have a PR for this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants