Skip to content

Instantly share code, notes, and snippets.

@Noviny

Noviny/Open Source Checklist.md

Last active November 5, 2018 22:10
Show Gist options
  • Save Noviny/9cb4cfeff59ac61388e602c82f78fbe2 to your computer and use it in GitHub Desktop.
Save Noviny/9cb4cfeff59ac61388e602c82f78fbe2 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
Open Source Checklist.md

Open Source Checklist

This checklist is aimed at javascript packages to be published to NPM. Let's break up the roles of various things

Code Necessities

  • package.json with the fields
    • name
    • version
    • description
    • main
    • author
    • license
    • repository
    • files (narrow what is published)
  • tests setup
  • Build step?

Documentation Necessities

  • README.md
  • CHANGELOG.md
  • LICENSE

Community Necessities

  • CONTRIBUTING.md
  • Code of conduct
  • README.md
  • Way to be contacted

Code Niceties

  • package.json fields:
    • keywords
    • email address in author
  • Scripts
    • Test
    • Deploy (test, lint)
  • More tests

Documentation Niceties

  • Code examples
  • Running examples
  • Changeset process
  • website

Community Niceties

  • Changeset process
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment