This document provides guidelines for contributions to shinymde.

Kinds of contribution

  • Typo fixes
  • Documentantion enhancements
  • Pull requests

Fixing typos and enhancing documentation

To fix typos and/or grammatical errors, please edit the corresponding .R or .md file that generates the documentation.

If edited via an .R file, please also update the docs using roxygen2 to generate the associated .Rd file.

Pull Requests

  • Please raise an issue for discussion and reproducibility checks at issues

  • Once the bug/enhancement is approved, please create a Git branch for the pull request.

  • Make changes and ensure that builds are passing the necessary checks on Travis.

Please note that the ‘shinymde’ project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.