Cc selfish reasons for reproducibility

[pagrubel]

Selfish Reasons for Reproducibility

Author: @pagrubel
EBmember: @bartlettroscoe

Resolves #2189

PR checklist for files displayed on bssw.io site

• [Author] @mention the BSSw.io editorial board member @<eb-member-id> in Description above assigned to shepherd your PR.
• [Author] Add the <issue-id> in the Description above for the associated GitHub Issue.
• [ ] [Author] Ensure wikize_refs.py -i <base>.md is run and commit (if using wikize_refs.py).
• [Author] Inspect the content in the *.md file(s) as rendered in GitHub for this PR.
• [EB Mem] Assign this PR to the EB member <eb-member-id>.
• [EB Mem] Assign this PR to the author of the PR <pr-author-id>.
• [EB Mem] Add one or more Reviewers.
• [EB Mem] Add label content: <content-type> for the type of contribution.
• [EB Mem] Add to Project Content Development (see Content Development).
• [EB Mem] Add meta-data to the *.md file(s) (set Publish: yes).
• [EB Mem] Add label preview (so PR branch will be merged to 'preview' branch and watch for possible merge failures).
• [EB Mem] Rebuild preview site and confirm new content is there, renders correctly and is returned in searches.
• [Author] Make any final changes to the PR based on feedback.
• [ ] [Author] Ensure wikize_refs.py -i <base>.md is run and commit (if using wikize_refs.py).
• [EB Mem] Rebuild preview site and re-confirm content looks correct.
• [EB Mem] Ensure at least one reviewer signs off on the final changes.
• [EB Mem] Move the PR to "Ready to Publish" in Content Development.
• [EB Mem] Leave comment and @mention @betterscientificsoftware/bssw-maint (BSSw Maint) asking to carry out final publication steps.
• [BSSw Maint] Verify that all needed files are present in the PR (article, images, updates to Site/Homepage.md carousel and/or Site/Announcements/Announcements.md as appropriate).
• [BSSw Maint] Merge PR. (Should automatically move to "Done" in Content Development.)
• [BSSw Maint] Verify new contribution shows up on bssw.io as expected.

NOTE:

• Checklist items prefixed with [Author] are expected to be performed by the author of the PR or can be performed by the author.
• Checklist items prefixed with [EB Mem] must be performed by a BSSw.io Editorial Board (EB) Member.
• Checklist items prefixed with [BSSw Maint] must be performed by someone in the @betterscientificsoftware/bssw-maint team (hint: type @, b, s, s, w, -, m to auto-complete to @betterscientificsoftware/bssw-maint).

[bartlettroscoe]

Look good. I would just suggest using bullets for the five reasons and put them up front, so people can pick these up fast. You might env bold them for people to make it really easy to see these (like I suggest below). If all people read is the bolded text, at least they have gained something :-)

[bartlettroscoe]

I would suggest moving up this list just after the first sentence and use bullets, like:

---

The author presents five reasons to work reproducibly:

• avoid disaster,
• make it easier to write papers,
• help reviewers see it your way,
• enable continuity of your work, and
• help to build your reputation

and discusses the implications of reproducible work as a scientific researcher. There are explanations of why working reproducibly is beneficial to you and your career. ...

[pagrubel]

I actually started with a bulleted list and will go back to that.

[pagrubel]

@bartlettroscoe Please look it over again and if you approve I'll rebuild the preview site and check that out. Assuming that all goes well, I'll merge it.

[bartlettroscoe]

Looks great. Thanks for the changes!