Contributing to egfr
Source:.github/CONTRIBUTING.md
Thanks for taking the time to contribute! The following is a short set of guidelines for contributing to egfr.
Reporting bugs
- Search the existing issues first to avoid duplicates.
- Open a new issue with a minimal reprex (a small, self-contained, reproducible example). For an eGFR equation, please include the inputs, the value you got, and the value you expected (with a reference where possible).
Pull requests
- Fork the repository and create a branch off
main. - Make your change. Keep the scope focused.
- Add or update tests in
tests/testthat/and rundevtools::test(). - Run
devtools::document()if you changed any roxygen comments. - Ensure
R CMD checkpasses cleanly (devtools::check()). - Open a pull request describing the change and linking any related issue.
Code style
- Follow the tidyverse style guide.
- Code is linted with lintr; see
.lintrfor the configuration used in CI.
Scientific accuracy
Because this package implements published clinical equations, any new equation or change to an existing one must cite a peer-reviewed source and include tests that reproduce published reference values.
Please note that this project is released with a Contributor Code of Conduct. By participating you agree to abide by its terms.