PULL_REQUEST_TEMPLATE.md 1.7 KB

To contribute a new article template to this package, please make sure you have done the following things (note that journalname_article below is only an example name):

  • [ ] Unless you have done it in any other RStudio's projects before, please sign the individual or corporate contributor agreement for a significant pull request (it is fine not to sign it if a PR is only intended to fix a few typos). You can send the signed copy to [email protected].

  • [ ] Add the journalname_article() function to R/journalname_article.R. If the article needs CSL to process citations, see the function acm_article() for an example; otherwise see asa_article() for an example. If you don't know what CSL means, see the latter.

  • [ ] Add the Pandoc LaTeX template inst/rmarkdown/templates/journalname_article/resources/template.tex.

  • [ ] Add a skeleton article inst/rmarkdown/templates/journalname_article/skeleton/skeleton.Rmd.

  • [ ] Add a description of the template inst/rmarkdown/templates/journalname_article/template.yaml.

  • [ ] Please include the document class file (*.cls) if needed, but please do not include standard LaTeX packages (*.sty) that can be downloaded from CTAN.

  • [ ] Update Rd and namespace (could be done by devtools::document()).

  • [ ] Update NEWS.

  • [ ] Update README with a link to the newly supported journal.

  • [ ] Add a test to tests/testit/test-formats.R.

  • [ ] Add your name to the list of authors Authors@R in DESCRIPTION. You don't need to bump the package version in DESCRIPTION.

Thank you!