Skip to content

Instantly share code, notes, and snippets.

@eigenhombre
Last active June 2, 2023 21:38
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save eigenhombre/204400c786f9dba3a8d3193d3ce1542a to your computer and use it in GitHub Desktop.
Save eigenhombre/204400c786f9dba3a8d3193d3ce1542a to your computer and use it in GitHub Desktop.
From https://gist.github.com/eigenhombre/204400c786f9dba3a8d3193d3ce1542a:
See also: http://johnj.com/posts/practices/
- [ ] LICENSE file, including disclaimer
- [ ] Automated build via Docker and GitHub Actions
- [ ] Automated builds include unit tests
- [ ] Automated builds include linting
- [ ] Artwork
- [ ] Versioned
- [ ] Link to API and/or `help` output
- [ ] Release procedure is automated
- [ ] Project available in public package manager
- [ ] Track outstanding TODOs in Issues
- [ ] Project has a README, with
- [ ] Minimum snippet / example; ideally, auto-updated in README.
- [ ] Build badge
- [ ] How to check out and build the software locally
- [ ] How to deploy, or directions to deploy documentation
- [ ] Where to find logs, or directions to run book
- [ ] How alerts, if any, are configured
- [ ] What, if anything, should be done if ownership changes (individual, or team)
- [ ] Links to any auto-generated code documentation
- [ ] Backup procedure is documented
- [ ] Anything that is incorrect or outdated should be removed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment