Contributing to recodeflow

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. When filing an issue, please use the issues template available on the GitHub repository.

Pull request

  • Please create a Git branch for each pull request (PR). Click here for information on how to create a PR.
  • Your contributed code should roughly follow the tidyverse style guide.
  • recodeflow uses roxygen2, with Markdown syntax, for documentation.
  • recodeflow uses testthat. Adding tests to the PR makes merging the PR into the code base less prone to bugs.
  • 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.