Open Robinlovelace opened 3 years ago
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.
:white_check_mark: cderv
:x: Robinlovelace
You have signed the CLA already but the status is still pending? Let us recheck it.
First pass, let's see what happens! Any feedback v. welcome.
Heads-up @cderv I think this is ready to be reviewed/merged as appropriate. The template generates nice outputs as can be seen here in this in-progress paper I'm working on: https://github.com/zonebuilders/zonebuilder/releases/download/0.0.1/zonebuilder-paper.pdf
Thanks I'll add it in the review todo 😅 I should go back to rticles next week I believe.
Thanks for all the feedback @cderv this is great and highly educational. Will look to update the PR and respond to your comments in due course.
Hi @Robinlovelace,
Friendly ping as I am going through PR for next version.
Is this something you are still planning to spend a bit of time off ?
No hurry. I just want to check the status of this PR. Thanks !
Sorry for slow reply. I still plan to do this but may be ~1 month before I get the dedicated time needed to move this forward. Looking forward to that time as it will be a learning experience!
Hi @Robinlovelace ,
Just to inform you that I took the time to merge master in this PR and fix the conflicts so that you can start on a better basis when you'll find time to continue the work.
Cheers,
Hi @Robinlovelace ! Just came across this while looking for another PR. Big JOSIS fan, so if you're still not seeing a window to take another look, I'll find time before the end of the year.
Many thanks @nuest let's do this. The PR is almost there but year, needs a bit of TLC. FYI the editors are aware and in support of this effort.
@nuest @Robinlovelace just a friendly ping to see if this is still a project. If you need my help to make JOSIS format happens, happy to schedule some time on this.
May need some help. Thanks for patience @cderv, will be worth it! JOSIS is a great open access journal and we're almost there. I will try to get some of the editorial team involved who my have comments also.
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):[x] 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). We use a tool called CLA assistant for that.
You could also, unless you have done it in any other RStudio's projects before, sign the individual or corporate contributor agreement. You can send the signed copy to jj@rstudio.com.
[x] Add the
journalname_article()
function toR/article.R
if the output format is simple enough, otherwise create a separateR/journalname_article.R
.[x] Add the Pandoc LaTeX template
inst/rmarkdown/templates/journalname/resources/template.tex
.[x] Add a skeleton article
inst/rmarkdown/templates/journalname/skeleton/skeleton.Rmd
.[x] Add a description of the template
inst/rmarkdown/templates/journalname/template.yaml
.[x] 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 viatinytex::parse_packages(files = "FILENAME"")
(e.g., whenFILENAME
isplain.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).[x] Update Rd and namespace (could be done by
devtools::document()
).[x] Update NEWS.
[x] 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).
[x] Add a test to
tests/testit/test-formats.R
by adding a linetest_format("journalname")
. We try to keep them in alphabetical order.[x] 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!