Outfunnel Javascript style guide
- Install the correct versions of each package, which are listed by the command:
npm info "eslint-config-outfunnel@latest" peerDependencies
- Add
"extends": ['outfunnel']
to your.eslintrc.js
- Clone the repository
- Run
npm install
to install dependencies - Make changes and commit
Tightening of any checks means breaking change and should be published with major version release. Relaxation of rules and fixing issues are published under minor and patch versions.
- Major: Breaking changes and/or major ESLint version update
- Minor: Relaxation of rules or fine-tuning current rules. Also when tightening rules to warn
- Patch: Fixing of minor oversights
- Run
npm version [patch|minor|major] -m "Version commit message"
- Add the version bump commit to the pull request
- Merge to master and GitHub Action will build, publish and then tag the commit if successful