Skip to content

Varinomics/varinomics-standards

Repository files navigation

Varinomics Coding Standards

The single source of truth for how code is written and reviewed across every Varinomics product. One repository, consumed two ways: read directly by people, and loaded by LLM coding agents (Claude Code and compatible tools) as a plugin. Keeping the rules in one versioned place is what stops each product from drifting into its own dialect.

The standards are split by concern: how to write (the coding-style guideline and its LLM addendum), what to critique (the review scope), and how to carry a change over time without it drifting (change governance).

The standards

  • varinomics_coding_style_guideline.md - the baseline rules: naming, structure, formatting, and C++/C-API conventions. Start here.
  • varinomics_coding_style_llm_addendum.md - house-style formatting judgment layered on top of the baseline (alignment, wrapping, visual-table patterns). Where it conflicts with the guideline, the addendum wins.
  • varinomics_review_scope.md - what a reviewer must and must not flag. Draws the line between baseline quality (always in scope) and elective features (in scope only when the project has adopted them), and sets when missing test coverage is a real finding versus correct-by-default.
  • varinomics_change_governance.md - rules for any change that spans more than one commit: migrations, refactors, multi-step features. Keeps them from accumulating duplicate code paths, dead code, silent fallbacks, premature test oracles, and deferred-then-forgotten work.
  • varinomics_review_planning_anti_patterns.md - a non-blocking diagnostic guide for recognizing when reviewer volume, process evidence, or plan growth has displaced engineering judgment.
  • varinomics_llm_tooling_windows.md - Windows command-invocation notes for LLM agents and automated tooling.
  • tools/ - the shared style-enforcement scripts and the canonical style pipeline.

Using it as a Claude Code plugin

This repository is also a Claude Code plugin marketplace, so an agent can pull the standards in on demand instead of reading every document up front. Install it straight from GitHub:

/plugin marketplace add Varinomics/varinomics-standards
/plugin install varinomics-standards@varinomics-standards

What that adds:

  • varinomics-reviewer (agent) - reviews a diff, PR, branch, or file against the standards, calibrated by the review scope so it flags baseline-quality problems without demanding elective features the project never took on. Dispatch it when you want a standards-aware review.
  • varinomics-change-governance (skill) - surfaces the governance rules before you start multi-commit work (a migration, a multi-step refactor) or introduce a test, so the discipline is in front of you when it matters rather than after.

The canonical documents above ship inside the plugin, and the agent and skill read them directly - there is no second copy to fall out of sync.

Style enforcement tools

tools/ holds the style checkers and style_pipeline.py, which declares the canonical order the tools run in. The pipeline rewrites files in place to apply the rules, then runs a read-only check to confirm the result is clean.

Run it from a product repository root:

python C:\plms\varinomics\varinomics-standards\tools\style_pipeline.py --write

Or pass an explicit product root:

python C:\plms\varinomics\varinomics-standards\tools\style_pipeline.py --root C:\plms\varinomics\galanthus --write

More about Varinomics: https://varinomics.com

About

Coding standards, review scope, and change-governance rules for Varinomics products.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages