-
Notifications
You must be signed in to change notification settings - Fork 518
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
close #125: add a contributing guide
- Loading branch information
Showing
1 changed file
with
25 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
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](https://rstudioblog.files.wordpress.com/2017/05/rstudio_individual_contributor_agreement.pdf) or [corporate](https://rstudioblog.files.wordpress.com/2017/05/rstudio_corporate_contributor_agreement.pdf) 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 <jj@rstudio.com>. | ||
|
||
- [ ] 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! |