Contributing to mapsf

This outlines how to propose a change to mapsf.

Fixing typos

You can fix typos, spelling mistakes, or grammatical errors in the documentation directly using the 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, you should 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).

The main branch hosts the code for the package version that is currently on CRAN. The dev branch is used for development purposes. This is the branch to fork if you want to propose a pull request.

Code style

• We use styler with current default values for code style.
• We use lintr with current default values for static code analysis.
• We use roxygen2 for documentation.
• We use tinytest for unit tests. Contributions with test cases included are easier to accept.

Support

You can ask questions about the package in the Issues section of this repository.

AI policy

For ethical reasons, this project does not accept AI generated contributions.