Mikmak-eslint

Mikmak's eslint rules

Usage

Extending your rules

# in your project folder
npm i @mikmak/eslint-config

then in your .eslintrc file add

{
  "extends": "@mikmak"
}

Deployment

We are using github actions/workflows to take care of deployment. We also use this action.

To publish simply bump the version and merge into main.

Contributing

1. create a new branch from the main branch.
2. make your commit message starting with one of these tags
   • New rule: [RULE]: for example [RULE] getter-return - enforce return statements in getters
   • Bug fixes: [BUGFIX]: for example [BUGFIX] fix rule not showing warning
   • [FEAT]: for example [FEAT] Adding new template for minor issues.
   • Or if there is a Clubhouse ticket associated use [CH{number of ticket}]: for example [CH1234] Adding new template for minor issues.
3. Rebase: to make sure you have the latest available code. This also helps keep a linear git history: info on rebasing
4. Push your changes
5. Make a PR with title using the above prefix (can just be a copy of the commit message if it starts with the tags)
6. add one of the following templates (this should also show up while making a PR).
   • New Rule: template
   • Bug Fixes: template
   • Feature or other: template
7. Wait for approvals (at least one person from each team).
8. Squash and merge into main. It is fine if there are multiple commits, with squash and merge these would turn into one commit. Squash and merge helps with having a linear git history. how to squash & merge on github.

Other things to keep in mind/ resources:

• Info on linear git history