Jingga/Developer-Guide
1
0
Fork 0
mirror of https://github.com/Karaka-Management/Developer-Guide.git synced 2026-01-11 20:38:42 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
5c3c0224ff
Developer-Guide/quality/inspections.md

1.6 KiB
Raw Blame History

Inspections

Code inspections are very important in order to maintain the same code quality throughout the application. The Build repository contains all esential configuration files for the respective inspection tools. Every provided module will be evaluated based on the predefined code and quality standards. Only modules that pass all code, quality and unit tests are accepted. This also applies to updates and bug fixes. Any change will have to be re-evaluated.

Tools

Tools used for the code inspection are:

  • PhpLoc
  • PhpMetrics
  • PhpUnit (see tests)
  • Jasmine (see tests)
  • Custom scripts/tools

These tools are all installed by running the setup.sh script from the Build repository.

External Tools

As external tool scrutinizer is used to automate code inspection and provide insight on issues, bugs, best practices etc.

Git Hooks (Linux only)

The git hooks perform various checks and validations during the commit and warn the developer about invalid code or code style/guideline violations.

For developers it is recommended to copy the contents of the default.sh file in the Build repository under Hooks to your pre-commit file in the .git/hooks directory. If the pre-commit file doesn't exist just create it.

The same should be done with every module. Simply go to .git/modules/**/hooks and also add the content of the default.sh file to all pre-commit files.

By doing this every commit will be inspected and either pass without warnings, pass with warnings or stop with errors. This will allow you to fix code before committing it. Be aware only changed files will be inspected. Also make sure all pre-commit have +x permissions.