Contributing to tsgames

The workflow for contributing a new game to tsgames:

• Fork the tsgames repository
• Make any and all additions to the codebase to include your game
  • Update the DESCRIPTION file to include yourself as an author
  • Use roxygen2 style comments for documentation
  • Include yourself as an author using the @author tag on the help page for your game
  • Don't forget to export the function that actually launches your game. (Use @export in your roxygen comments)
  • Update the documentation using either roxygenize (roxygen2) or document (devtools).
  • If you want to do unit testing (and it is recommended) we use the testthat package. An intro to the testthat package can be found in the R journal
• Once the additions have been made make sure that you incorporate any changes from TalkStats:tsgames into your fork.
  • For directions on this read the "Pull in upstream changes" section here
• Submit a pull request to TalkStats:tsgames so that your changes will be incorporated into the main repository itself.
• Remind Dason to buy you a beer the next time you're at a pub together.