Sharing Code Well

Eric Earl, NIMH

Data Science & Sharing Team

Good documentation lowers the barrier to entry, making it easier to understand and start using.

2.

Document the

undocumented &

consider your audience

1.

Version control with good commit messages & upload to GitHub

3.

Prepare metadata like

a DOI & a license

4.

Test your docs &

checklist your fixes

5.

Release with semantic versioning & a changelog

Do

  • Make a public GitHub repo
  • Make docs that target your audience and test them
  • Get a DOI on Zenodo or OSF
  • Document both what it does and doesn't do
  • Comment your code
  • Release incrementally

Don't

  • Share PHI or PII
  • Hide your mistakes
  • Let your scope or plans change for releases
  • Make an over-sized README without pictures or tables

Hooray!

Ready to share?

Made with Slides.com