CONTRIBUTING.md

Development guidelines

We try to follow the GitHub flow for development.

  1. Fork [this repo][repo] and clone it to your computer. To learn more about this process, see this guide.
  2. If you have forked and cloned the project before and it has been a while since you worked on it, merge changes from the original repo to your clone by using: git fetch upstream followed by git merge upstream/master.
  3. Open the RStudio project file (.Rproj).
  4. Make your changes:
    • Write your code.
    • Test your code (bonus points for adding unit tests).
    • Document your code (see function documentation above).
    • Do an R CMD check using devtools::check() and aim for 0 errors and warnings.
    • Commit your changes locally
    • Merge changes from the original repo (again)
    • Do an R CMD check using devtools::check() and aim for 0 errors and warnings.
  5. Commit and push your changes.
  6. Submit a pull request.


folkehelseinstituttet/dashboards_sykdomspuls_pdf documentation built on May 6, 2019, 1:35 a.m.