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

JOSE Review Comments #292

Closed
jhollist opened this issue May 1, 2019 · 3 comments
Closed

JOSE Review Comments #292

jhollist opened this issue May 1, 2019 · 3 comments

Comments

@jhollist
Copy link

jhollist commented May 1, 2019

All, very nice job on the course and the JOSE submission!

I am mostly finished with the review over at openjournals/jose-reviews#49 but had a few specific comments to leave here. Once these are addressed, I should be able to complete the review checklist.

As I mention on the JOSE issue, I though these course materials were excellent. Will certainly be recommending them.

Any question about these comments, just let me know.

Specific Comments

Authorship

Installation Instructions and Usage

  • Create a separate section in README for installation.
  • More explicit step by step instructions on how to create your own version of the course would be really useful. Reason for rolling your own instructions is because some of what is suggested in the Bookdown docs, is taken care of in your .travis.yml and the gh-pages branch suggested in Bookdown isn't needed. Thus, as is, to get your own site up and running requires some prior experience with GitHub Pages and Travis. I think having more specific instructions that are geared towards your repository would be beneficial
  • In this section, might want to add "fork to you own repo" as a first step.
  • Include some warning about how long the Travis-CI build will take.

Community Guidelines

  • The CONTRIBUTING.md is well done, but a little hidden under the Lecture Content section. Create a separate section for this.

References

@lwjohnst86
Copy link
Member

Thanks for the comments and feedback @jhollist! We really appreciate them :) We'll work to address these changes!

@lwjohnst86
Copy link
Member

@jhollist Sorry for the delay. We've updated the repo as per your requests!

@jhollist
Copy link
Author

jhollist commented Jun 4, 2019

@lwjohnst86 Looks good! Heading over the finish up my checklist now.

Congrats, this is a really nice looking course!

This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants