Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

starting to add jors #397

Draft
wants to merge 12 commits into
base: main
Choose a base branch
from
Draft

starting to add jors #397

wants to merge 12 commits into from

Conversation

gpilgrim2670
Copy link

@gpilgrim2670 gpilgrim2670 commented May 4, 2021

I'm working on building a template for the Journal of Open Research Software.

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

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

  • 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!

@CLAassistant
Copy link

CLAassistant commented May 4, 2021

CLA assistant check
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.

✅ cderv
❌ gpilgrim2670
You have signed the CLA already but the status is still pending? Let us recheck it.

@cderv
Copy link
Collaborator

cderv commented Jun 9, 2021

@gpilgrim2670 do not forget to undraft this PR and ping me when this is ready for review.

Just checking in case you were already waiting for a review. Otherwise, take your time. Thanks

@gpilgrim2670
Copy link
Author

@cderv thanks for checking in. I'm actually waiting to hear back from the folks at JORS about some issues with their reference formatting style. Hopefully they'll get back to me soon, but I suspect it will be a while...

@cderv
Copy link
Collaborator

cderv commented Jun 9, 2021

We are in no hurry. Thanks for the update !

@cderv
Copy link
Collaborator

cderv commented Nov 30, 2021

Hi @gpilgrim2670,

I have just merge master branch in this PR to take into account the changes we've made recently. This will allow you to continue on good basis next time you work on this format.

Thanks.

@cderv
Copy link
Collaborator

cderv commented Apr 19, 2023

👋 @gpilgrim2670 - coming back here to get fresh information on the status of this work. Do you still plan to work on it ? Did you get feedback from JORS people ?

thank you

@cderv cderv added the WIP label Apr 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants