Release cheatsheet

Pre-release checklist for `generator-community`

Before you release generator-community, ensure the following conditions are met.

1. Tasks

📝 Source: npm-module-checklist

1. Watch the egghead.io series How to Write an Open Source JavaScript Library; it is extremely useful for any NPM project (OSS or closed-sourced).
2. All specs (unit tests) pass within the currently accepted coverage thresholds.
3. ESLint passes.
4. Code quality gates pass
5. npm run release -- --dry-run produces the complete list of BREAKING CHANGES, features, or fixes to be released.
6. Logging library to show more information during debugging or verbose mode. debug, logdown
7. CI buids pass for all target hosts.
8. Neither NSP or ESLint report potential vulnerabilities snyk, NodeSecurity
9. Check module published size and white list only necessary files, tree-shaking, deduping, and pruning where possible tutorial
10. Lock the exact versions of the top level dependencies. Use save-exact NPM setting and exact-semver to enforce it.
11. Greenkeeper is set up for automatic pull requests when newer versions of dependencies appear greenkeeper.io
12. If writing a CLI tool, add a way to check if it is out of date and should be upgraded; update-notifier
13. Validate package.json values using grunt-nice-package or fixpack
14. Installation commands and documentation are available and ready.
15. Documentation have been updated. xplain is my own tool for JS to HTML/Markdown generation
16. Place most of the public API documentation in README file for simple retrieval. This allows other developers to find relevant sections right from the command line manpm or by looking up npm home package-name
17. Use a library to output the correct plural forms of words in the user messages pluralize