.github/CONTRIBUTING.md

Contributing to cageminer

This outlines how to propose a change to cageminer. For more detailed info about contributing to this, and other tidyverse packages, please see the development contributing guide.

Fixing typos

You can fix typos, spelling mistakes, or grammatical errors in the documentation directly using the GitHub web interface, as long as the changes are made in the source file. This generally means you'll need to edit roxygen2 comments in an .R, not a .Rd file. You can find the .R file that generates the .Rd by reading the comment in the first line.

Bigger changes

If you want to make a bigger change, it's a good idea to first file an issue and make sure someone from the team agrees that it’s needed. If you’ve found a bug, please file an issue that illustrates the bug with a minimal reprex (this will also help you write a unit test, if needed).

Pull request process

Code style

Code of Conduct

Please note that the cageminer project is released with a Contributor Code of Conduct. By contributing to this project you agree to abide by its terms.



almeidasilvaf/cageminer documentation built on Sept. 9, 2023, 5:18 p.m.