Thank you for your interest in contributing to betaregscale! This document provides guidelines for contributing to the project.
How to contribute
Reporting issues
If you find a problem, please open an issue on GitHub with:
- A minimal reproducible example
- The output of
sessionInfo() - A clear description of the expected vs. actual behavior
Suggesting features
Feature requests are welcome. Please open an issue describing the use case and expected behavior.
Pull requests
- Fork the repository and create a feature branch from
main. - Follow the existing code style (snake_case, roxygen2 documentation).
- Add tests for new functionality using
testthat. - Run
devtools::check()and ensure 0 errors, 0 warnings, 0 notes. - Update documentation with
devtools::document()if needed. - Submit a pull request with a clear description of the changes.
Development setup
# Install development dependencies
install.packages(c("devtools", "testthat", "roxygen2", "knitr", "rmarkdown"))
# Clone and install
# git clone https://github.com/evandeilton/betaregscale.git
devtools::install_dev_deps()
devtools::load_all()
# Run tests
devtools::test()
# Full check
devtools::check()Code style
- Use
snake_casefor function and variable names. - Document all exported functions with roxygen2.
- Internal functions should use
@keywords internal. - Keep lines under 80 characters when possible.