Skip to contents

Contributing to pharmhand

Source: CONTRIBUTING.md

Contributions are welcome and appreciated.

Getting started

  1. Fork the repository and clone your fork
  2. Install dependencies: devtools::install_dev_deps()
  3. Create a branch for your changes: git checkout -b feature/your-feature

Development workflow

Code style

This package follows the tidyverse style guide. Before submitting:

# Format code
styler::style_pkg()

# Check linting
lintr::lint_package()

Testing

Add tests for new functionality in tests/testthat/. Run tests with:

devtools::test()

Documentation

  • Use roxygen2 for function documentation
  • Include @examples where practical
  • Run devtools::document() to update docs

Checking

Before submitting a PR, run:

devtools::check()

Pull requests

  1. Update NEWS.md with a summary of changes
  2. Ensure CI checks pass
  3. Keep PRs focused on a single feature or fix

Reporting issues

Use GitHub Issues to report bugs or request features. Include a minimal reproducible example when reporting bugs.

Code of Conduct

Please note that this project has a Code of Conduct. By participating, you agree to abide by its terms.