Many hands make light work! Here are some ways you can contribute to this project:
- You can open an issue if you’d like to request a specific function or report a bug/error.
- 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
.Rdfile. You can find the
.Rfile that generates the
.Rdby reading the comment in the first line.
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!
We use testthat for unit tests. Contributions with test cases included are easier to accept.