.github/CONTRIBUTING.md

In sckott/discgolf: Discourse API Client

CONTRIBUTING

Fixing typos

Small typos or grammatical errors in documentation may be edited directly using the GitHub web interface, so long as the changes are made in the source file.

• YES: you edit a roxygen comment in a .R file below R/.
• NO: you edit an .Rd file below man/.

Pull request process

• We recommend that you create a Git branch for each pull request (PR).
• Look at the Travis and AppVeyor build status before and after making changes. The README should contain badges for any continuous integration services used by the package.
• We recommend the tidyverse style guide. You can use the styler package to apply these styles, but please don't restyle code that has nothing to do with your PR.
• We use roxygen2.
• We use testthat. Contributions with test cases included are easier to accept.

Code of Conduct

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

Prefer to Email?

Do not send an email; open an issue.

sckott/discgolf documentation built on March 10, 2021, 5:30 p.m.