kademi-coding-standards
Kademi's house coding standards, the review that checks code against them, and how to confirm a change actually works before handing it over. Use before finishing any change to a Kademi app, lib or theme, whenever asked to review, check, audit, lint or sanity-check Kademi code, asked "is this the right way to do it on Kademi", or asked whether something was tested. Names every house rule and where it is documented - service and manager API design, controller versus service separation, transactions, error handling, Nashorn versus GraalJS, logging, client-side JavaScript, LESS and CSS - carries the runnable review to run over changed files, and covers verifying the result on the account - that the app still loads, that each registration is live rather than merely written in a file, and what to run to prove the code itself works. For tracking down a server-side failure, use kademi-server-js.
- Version
- 0.1
- License
- Apache-2.0
Pinned to revision 531e3b71a498, so it is the text this page describes rather than whatever the author pushed since.
Files
- skills/kademi-coding-standards/SKILL.md
- skills/kademi-coding-standards/references/review.md
- skills/kademi-coding-standards/references/verification.md
Every link opens the file at its source, pinned to the revision this page describes.