This document is intended to provide some guidance to those wondering how and whether they should make changes to this repository. We do welcome your input! Please see and abide by the code of conduct when contributing.
As a general rule, please submit changes as a pull request. If you'd like to make a change that isn't small, it would be wise to contact the instructor of the course (probably @vincenzocoia
and/or @firasm
) to pass the idea by them.
TA's for the course should feel free to commit to master
when it comes to things like updating assignments and peer review information. Otherwise, please adopt the "General Rule".
We adopt high standards when it comes to material that is published to the STAT 545 @ UBC website.
- Code should always appear in code font.
- Functions are referred to like
sqrt()
, notsqrt
. - Sentences should end with a period.
- Proper English, spelling, and grammar are to be observed whenever appropriate.
- Code adopts the tidyverse style guide