CONTRIBUTING.md

In corybrunson/tdaunif: Uniform Manifold Samplers for Topological Data Analysis

Contributing to tdaunif development

The goal of this guide is to help contributors to tdaunif plan their contributions and navigate the process. The sections below cover different types of contributions, usually with increasing degrees of proposed change.

Note that tdaunif is released with a Contributor Code of Conduct. By contributing, you agree to its terms.

This guide is loosely adapted from the contributing guides for ggplot2 and from ropensci. If you have questions about or suggestions for this guide, please feel free to contact a package maintainer.

Editor

Small edits to comments, documentation, and other non-code files may be made using the GitHub file editor. To edit roxygen2 documentation, make changes to a source file R/<topic>.r, on a line that begins with #', rather than to a documentation file man/<topic>.Rd.

For more guidance on roxygen2 documentation, see this chapter in the online book R packages.

Issues

Questions, possible bugs, feature requests, other open-ended issues may be raised as issues on GitHub. In most cases, the issue should consist of two sections: a description of the issue, and a reproducible example of it. A reproducible example should attach packages, include data, and execute code:

1. Attach all relevant packages at the top of the example.

2. Use as few and as simple objects as possible to illustrate the issue. If the issue involves one or more custom objects <object>, these should be reconstructed in the code rather than read from files, as follows:

   1. Execute dput(<object>) in R.
   2. Copy the output.
   3. Paste this code into the example after the package attachments.

3. Use as few lines or steps of code as feasible to illustrate the issue. Add comments at key steps.

For more guidance on reproducible examples, see this vignette for the reprex package.

Pull requests

Bug fixes, feature upgrades, and other substantive, self-contained changes may be contributed via pull request. Unless previously discussed with a maintainer, please follow these steps:

1. Fork the home repository (tdaverse/tdaunif).
2. Create a new (local) branch on which to make changes. If appropriate, update the documentation on this branch and run functionality checks (e.g. using the devtools package).
3. Push this new branch to the fork and open a pull request from it to the home repository.
4. With the maintainer(s), discuss and (if necessary) update the pull request until it is accepted or decided against. In the latter case, the maintainer(s) should provide a clear and consistent reason.

For more guidance on the pull request process, see the contributing guidelines for ggplot2.

corybrunson/tdaunif documentation built on Feb. 2, 2024, 8:22 p.m.