.github/PULL_REQUEST_TEMPLATE.md

In rstudio/rticles: Article Formats for R Markdown

How to contribute a new output format ?

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

• [ ] This project uses a Contributor Licence Agreement (CLA) that you'll be asked to sign when opening a PR. This is required for a significant pull request (it is fine not to sign it if a PR is only intended to fix a few typos). Unless you have done it in any other RStudio / Posit projects before, sign the individual or corporate contributor agreement as appropriate. You can send the signed copy to [e-mail].

• [ ] Add the journalname_article() function to R/article.R if the output format is simple enough, otherwise create a separate R/journalname_article.R.

• [ ] Document your function using roxygen2. Markdown syntax is supported. Refer to https://roxygen2.r-lib.org/articles/rd-formatting.html for formatting references.

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

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

• [ ] Add a description of the template inst/rmarkdown/templates/journalname/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. If you are using TinyTeX or TeX Live, you can verify if a package is available on CTAN via tinytex::parse_packages(files = "FILENAME"") (e.g., when FILENAME is plain.bst, it should return "bibtex", which means this file is from a standard CTAN package). Please keep the number of new files absolutely minimal (e.g., do not include PDF output files), and also make examples minimal (e.g., if you need a .bib example, try to only leave one or two bibliography entries in it, and don't include too many items in it without using all of them).

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

• [ ] Update NEWS.

• [ ] Update README with a link to the newly supported journal. Please add your Github username and the full name of the journal (follow other examples in the list).

• [ ] Add a test to tests/testit/test-formats.R by adding a line test_format("journalname"). We try to keep them in alphabetical order.

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

Lastly, please try your best to do only one thing per pull request (e.g., if you want to add two output formats, do them in two separate pull requests), and refrain from making cosmetic changes in the code base: https://yihui.name/en/2018/02/bite-sized-pull-requests/

Thank you!

rstudio/rticles documentation built on June 4, 2024, 6:16 p.m.