Contributing to mediamix
Source:.github/CONTRIBUTING.md
Bug reports, questions and pull requests are welcome.
Reporting a bug
Open an issue with a minimal reproducible example: the smallest data and the shortest call that show the problem, the output you got, and the output you expected. The reprex package formats this well. Include the result of sessionInfo().
Changing code
- Fork the repository and create a branch from
main. - Install the development dependencies with
remotes::install_deps(dependencies = TRUE). - Make the change and add a test under
tests/testthat/that fails before it and passes after. - If you change roxygen comments, run
devtools::document()and commit the regenerated files inman/andNAMESPACE. - If you change
README.Rmd, rundevtools::build_readme()and commitREADME.mdwith any figures it rewrites inman/figures/. Do not editREADME.mdby hand. - Run
devtools::check()and make sure it reports no errors or warnings. - Add a bullet to the development section of
NEWS.md, under the heading that fits, describing the user-visible change.
Commit messages use an imperative subject line under 72 characters, with a body when the reason for the change is not obvious from the diff.