.github/CONTRIBUTING.md

In nflverse/nflplotR: NFL Logo Plots in 'ggplot2' and 'gt'

Contributing

Many hands make light work! Here are some ways you can contribute to this project:

Open an issue

• You can open an issue if you'd like to request a specific function or report a bug/error.

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).

• You can also bring up changes in the nflverse discord and our team will be happy to discuss!

Code style

• New code should follow 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, with Markdown syntax, for documentation.

• We use testthat for unit tests. Contributions with test cases included are easier to accept.

Code of Conduct

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

These contribution guidelines were inspired by the guidelines from {usethis}

nflverse/nflplotR documentation built on Dec. 15, 2024, 11:09 a.m.