This outlines how to propose a change to bllflow.

Documentation

Where possible, use the pbc data, from survival package, for examples, vignettes or to demonstrate an issue. bllflow includes a DDI metadata file for the pbc data. See ../inst/extdata/pbcDDI.xml

Linking to Images

When linking to images in .Rmd files, make sure to add the relative path to the image in the resource_files section of the .Rmd file. An example is given below,

resource_files:
  - ../man/figures/coding.png

Linking to other .Rmd files

When linking to other .Rmd files make sure their extension is changed to .html. This ensures that the links continue to work when they are converted to the pkgdown site

Filing an issue

The easiest way to propose a change or new feature is to file an issue. If you’ve found a bug, you may also create an associated issue. If possible, try to illustrate your proposal or the bug with a minimal reproducible example.

Pull request

  • Please create a Git branch for each pull request (PR).
  • Your contributed code should roughly follow the tidyverse style guide. Exceptions from this guide: function names in PascalCase (e.g. NewFunction()) and variable names as camelCase (e.g newVariable <- “hi”).
  • bllflow uses roxygen2, with Markdown syntax, for documentation.
  • bllflow uses testthat (TBA). Adding tests to the PR makes it easier for me to merge your PR into the code base.
  • If your PR is a user-visible change, you may add a bullet to the top of NEWS.md describing the changes made. You may optionally add your GitHub username, and links to relevant issue(s)/PR(s).

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.