Skip to content

clutcher/laminar

v0.71.2MIT AND CC-BY-4.0

Reviews code against the three qualities of high-quality code in Laminar Software Design: simple to understand and change, correct in behavior, and fast enough for its purpose. A simplicity finding names the cognitive failure a reader meets, a correctness finding names the missing prevention decision or the missing test, and a performance finding names the waste a known alternative avoids. A coding style skill gives the same book's design directions, each with its reason, for any code that is written or changed.

code-style

Gives the design directions of the book Laminar Software Design, each with its reason, for any code that is written or changed, whatever the reason for the change, such as a new feature, a bug fix, a pull request comment, the fix of a review finding, or a refactor. It covers names, method bodies, classes, modules, types that hold state, entry boundaries, tests, I/O and comments, and gives for each design direction the cognitive failure it prevents or its correctness or performance reason. Use it whenever code is written or changed, in any language. It is not a review. It reports no findings and judges no existing code on its own, and it shapes the code while it is written.

Read SKILL.md at the source

Pinned to revision 52725c97eeaa, so it is the text this page describes rather than whatever the author pushed since.

Files

Every link opens the file at its source, pinned to the revision this page describes.