Skip to content

Outfunnel Javascript style guide

License

Notifications You must be signed in to change notification settings

outfunnel/eslint-config-outfunnel

Repository files navigation

eslint-config-outfunnel

Outfunnel Javascript style guide

How to use

  1. Install the correct versions of each package, which are listed by the command:
npm info "eslint-config-outfunnel@latest" peerDependencies
  1. Add "extends": ['outfunnel'] to your .eslintrc.js

How to develop

  • Clone the repository
  • Run npm install to install dependencies
  • Make changes and commit

Versioning

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

How to publish new version

  • 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