.github/CONTRIBUTING.md

Contributing to textprepr

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

Type of Contributions

Report Bugs

If you are reporting a bug, please open a GitHub issue, which include:

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.

Write Documentation

You can never have enough documentation! Please feel free to contribute to any part of the documentation, such as the official docs, docstrings, or even on the web in blog posts, articles, and such. For docstrings, please make you follow the roxygen2 format.

Other 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

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include additional tests if appropriate.
  2. If the pull request adds functionality, the docs should be updated.
  3. The pull request should work for all currently supported operating systems and versions of Python.
  4. The pull request shall include a brief description that explain the modification made and purpose of improvement.

Code style

Code of Conduct

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



UBC-MDS/textprepr documentation built on Feb. 5, 2022, 8:13 a.m.