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 Paper #14

Merged
merged 14 commits into from
Sep 26, 2024
Merged

JOSE Paper #14

merged 14 commits into from
Sep 26, 2024

Conversation

jatkinson1000
Copy link
Owner

@jatkinson1000 jatkinson1000 commented Aug 15, 2024

Upload first draft of JOSE paper [WIP] and CI action to generate online.

I have cherry picked from the summer school repo back to main here as best as I can as this one is the origin.
The one thing I do not have yet is the work on Licenses and Repos - this appears in my git and github workshop, but perhaps it is nice to have in both so they can be more standalone?

Much of the text in the paper is there, with a couple more sections that I need to flesh out.
I have added an action that generates the pdf (see the PR checks below).

Comments or reviews very much appreciated (and PRs).
Other examples of JOSE papers, and submisison guidelines, can be found here: https://jose.theoj.org/papers/published

It would be good if we can all be happy and in a position to submit by 23rd August 2024.

Tagging @MarionBWeinzierl and @AmyOctoCat to review.

@jatkinson1000 jatkinson1000 self-assigned this Aug 15, 2024
Copy link
Collaborator

@MarionBWeinzierl MarionBWeinzierl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Started adding some suggestions, will hopefully find time for making some changes tomorrow or next week

JOSE_paper/paper.md Show resolved Hide resolved
JOSE_paper/paper.md Show resolved Hide resolved
JOSE_paper/paper.md Outdated Show resolved Hide resolved
JOSE_paper/paper.md Show resolved Hide resolved
JOSE_paper/paper.md Show resolved Hide resolved
JOSE_paper/paper.md Outdated Show resolved Hide resolved
Copy link
Contributor

@AmyOctoCat AmyOctoCat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great :) Just a couple of very small suggestions.

JOSE_paper/paper.md Outdated Show resolved Hide resolved
JOSE_paper/paper.md Outdated Show resolved Hide resolved
JOSE_paper/paper.md Outdated Show resolved Hide resolved
JOSE_paper/paper.md Outdated Show resolved Hide resolved
Copy link
Contributor

@AmyOctoCat AmyOctoCat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have made a couple of suggestions, but these are more stylistic, so I'm approving as I'm happy for this to go ahead either way. :)

@jatkinson1000
Copy link
Owner Author

jatkinson1000 commented Aug 23, 2024

Outstanding tasks:

  • Cherry-pick the README and LICENSE commits from the summer school repo and move over here in a PR.
  • Add description of README and Licenses to paper text
  • Finish discussion of content delivery
  • Finish discussion of teaching experience
  • Ensure rest of repository is at JOSE Standards
    • Add ToC to README (and restructure to place exercises above setup?)
    • make sure learning objectives match paper
    • Apply a version number? - or wait until after review
    • Rename repo to be "RSE Skills"
    • Add links to paper
    • Render slides to github.io? instead of jackatkinson.net?
  • Submit to JOSE

@jatkinson1000 jatkinson1000 force-pushed the JOSE branch 2 times, most recently from 87e4664 to 7ddd953 Compare September 19, 2024 16:49
@jatkinson1000
Copy link
Owner Author

OK @MarionBWeinzierl and @AmyOctoCat

I think I am pretty much happy with this now (just pushed updates and tweaks, so will come back tomorrow and read fresh after a break).

One thought was I wonder if we can cite https://jose.theoj.org/papers/10.21105/jose.00144 somewhere as something that our course here is complementary to - a 'philosophy' component to their 'hard' content.

Please could you take a read and see how you feel, and think about how we compare to the submission criteria here: https://openjournals.readthedocs.io/en/jose/submitting.html (paper and repo).

@AmyOctoCat feel free not to do anything or look in great detail (though an "I'm still happy to be included" would be appreciated 😄).

@MarionBWeinzierl
Copy link
Collaborator

One thought was I wonder if we can cite https://jose.theoj.org/papers/10.21105/jose.00144 somewhere as something that our course here is complementary to - a 'philosophy' component to their 'hard' content.

Maybe it could be added in the summary, where the FAIR paper is also cited. Or in the teaching strategy part.

Copy link
Collaborator

@MarionBWeinzierl MarionBWeinzierl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some comments you might agree or disagree with

JOSE_paper/paper.md Show resolved Hide resolved
JOSE_paper/paper.md Outdated Show resolved Hide resolved
JOSE_paper/paper.md Show resolved Hide resolved
JOSE_paper/paper.md Show resolved Hide resolved
JOSE_paper/paper.md Outdated Show resolved Hide resolved
@jatkinson1000
Copy link
Owner Author

Squashing and merging for submission now.

@jatkinson1000 jatkinson1000 merged commit ff714bc into main Sep 26, 2024
2 checks passed
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

Successfully merging this pull request may close these issues.

3 participants