quality-bot
Version:
QBot Online Code Review Application
31 lines (20 loc) • 1.78 kB
Markdown
# Quality-bot [](https://img.shields.io/npm/v/quality-bot?style=flat-square) [](https://img.shields.io/node/v-lts/quality-bot?label=Node%20)
-------------------------------------
<img alt="Logo" align="right" src="https://qbot.mookambikainfo.com/favicon.png" width="10%" />
Quality-bot aims to improve the code quality of the developer in order to reduce the qbot comments. Before every commit, quality-bot reviews the staged files by predefined rulesets from the qbot. If the reviewed file have any comments from the qbot the commit will be automatically aborted. Before we work together, it would be great if you follow the below setups.
#### Qbot Configuration - One time setup
npx quality-bot configure
By executing this command, quality-bot will ask three parameters for configuration setup
1.Qbot token (Token will be provided by Qbot system admin team)
2.Git Core Hooks Path (if the users wants to use existing core hooks path they can or the users can provide any hooks path they wants)
3.Environment (global / local)
- Local level configuration is applied to the current repository.
- Global level configuration is applied for all the repositories.
#### Notes
-------------------------------------
1.Quality-bot's review details will not persist.
2.If you want toIgnore the comment you can use -n optinal parameter at the time of commit
- git commit -m "You Commit Message" -n
- git commit -m "You Commit Message" --no-verify
This option bypasses the pre-commit and commit-msg hooks.
3.In case there is any ghook with pre-commit configured in package level will be skipped. Because, git gives high priority to core hooks path.