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

Add to "How to Contribute" checking git artifact that PDFs knit (and anything else someone should know/do when contributing) #227

Open
lemireg opened this issue Aug 12, 2024 · 1 comment

Comments

@lemireg
Copy link

lemireg commented Aug 12, 2024

image

^^ is there a benefit to checking git artifacts to see things knit (binary yes/no) (all that is checked in tests right?), or is the benefit of git artifacts only in seeing the content of the PDF.

This may just be an extra line in the "How to Contribute" page: https://github.com/FredHutch/VISCtemplates/blob/main/CONTRIBUTING.md

@slager
Copy link
Contributor

slager commented Aug 13, 2024

Yes, the unit tests should fail if a report doesn't knit. The main intent of the artifacts is to be able to visually inspect the knit documents, and to be able to look at the intermediate/log/test files when debugging.

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

No branches or pull requests

2 participants