From c547823c534d7e163dc6d96cee35009e6425647b Mon Sep 17 00:00:00 2001 From: Affaan Mustafa Date: Sun, 5 Apr 2026 20:05:50 -0700 Subject: [PATCH] docs: narrow coding standards scope --- .agents/skills/coding-standards/SKILL.md | 23 +++++++++++++++++++++-- WORKING-CONTEXT.md | 1 + skills/coding-standards/SKILL.md | 23 +++++++++++++++++++++-- 3 files changed, 43 insertions(+), 4 deletions(-) diff --git a/.agents/skills/coding-standards/SKILL.md b/.agents/skills/coding-standards/SKILL.md index 200b55c0..48a62811 100644 --- a/.agents/skills/coding-standards/SKILL.md +++ b/.agents/skills/coding-standards/SKILL.md @@ -1,12 +1,18 @@ --- name: coding-standards -description: Universal coding standards, best practices, and patterns for TypeScript, JavaScript, React, and Node.js development. +description: Baseline cross-project coding conventions for naming, readability, immutability, and code-quality review. Use detailed frontend or backend skills for framework-specific patterns. origin: ECC --- # Coding Standards & Best Practices -Universal coding standards applicable across all projects. +Baseline coding conventions applicable across projects. + +This skill is the shared floor, not the detailed framework playbook. + +- Use `frontend-patterns` for React, state, forms, rendering, and UI architecture. +- Use `backend-patterns` or `api-design` for repository/service layers, endpoint design, validation, and server-specific concerns. +- Use `rules/common/coding-style.md` when you need the shortest reusable rule layer instead of a full skill walkthrough. ## When to Activate @@ -17,6 +23,19 @@ Universal coding standards applicable across all projects. - Setting up linting, formatting, or type-checking rules - Onboarding new contributors to coding conventions +## Scope Boundaries + +Activate this skill for: +- descriptive naming +- immutability defaults +- readability, KISS, DRY, and YAGNI enforcement +- error-handling expectations and code-smell review + +Do not use this skill as the primary source for: +- React composition, hooks, or rendering patterns +- backend architecture, API design, or database layering +- domain-specific framework guidance when a narrower ECC skill already exists + ## Code Quality Principles ### 1. Readability First diff --git a/WORKING-CONTEXT.md b/WORKING-CONTEXT.md index ba4ee28e..148a90b1 100644 --- a/WORKING-CONTEXT.md +++ b/WORKING-CONTEXT.md @@ -90,6 +90,7 @@ Keep this file detailed for only the current sprint, blockers, and next actions. ## Latest Execution Notes +- 2026-04-05: Continued `#1213` overlap cleanup by narrowing `coding-standards` into the baseline cross-project conventions layer instead of deleting it. The skill now explicitly points detailed React/UI guidance to `frontend-patterns`, backend/API structure to `backend-patterns` / `api-design`, and keeps only reusable naming, readability, immutability, and code-quality expectations. - 2026-04-05: Fixed the `main` npm CI break after the latest direct ports. `package-lock.json` had drifted behind `package.json` on the `globals` devDependency (`^17.1.0` vs `^17.4.0`), which caused all npm-based GitHub Actions jobs to fail at `npm ci`. Refreshed the lockfile only, verified `npm ci --ignore-scripts`, and kept the mixed-lock workspace otherwise untouched. - 2026-04-05: Direct-ported the useful discoverability part of `#1221` without duplicating a second healthcare compliance system. Added `skills/hipaa-compliance/SKILL.md` as a thin HIPAA-specific entrypoint that points into the canonical `healthcare-phi-compliance` / `healthcare-reviewer` lane, and wired both healthcare privacy skills into the `security` install module for selective installs. - 2026-04-05: Direct-ported the audited blockchain/web3 security lane from `#1222` into `main` as four self-contained skills: `defi-amm-security`, `evm-token-decimals`, `llm-trading-agent-security`, and `nodejs-keccak256`. These are now part of the `security` install module instead of living as an unmerged fork PR. diff --git a/skills/coding-standards/SKILL.md b/skills/coding-standards/SKILL.md index 200b55c0..48a62811 100644 --- a/skills/coding-standards/SKILL.md +++ b/skills/coding-standards/SKILL.md @@ -1,12 +1,18 @@ --- name: coding-standards -description: Universal coding standards, best practices, and patterns for TypeScript, JavaScript, React, and Node.js development. +description: Baseline cross-project coding conventions for naming, readability, immutability, and code-quality review. Use detailed frontend or backend skills for framework-specific patterns. origin: ECC --- # Coding Standards & Best Practices -Universal coding standards applicable across all projects. +Baseline coding conventions applicable across projects. + +This skill is the shared floor, not the detailed framework playbook. + +- Use `frontend-patterns` for React, state, forms, rendering, and UI architecture. +- Use `backend-patterns` or `api-design` for repository/service layers, endpoint design, validation, and server-specific concerns. +- Use `rules/common/coding-style.md` when you need the shortest reusable rule layer instead of a full skill walkthrough. ## When to Activate @@ -17,6 +23,19 @@ Universal coding standards applicable across all projects. - Setting up linting, formatting, or type-checking rules - Onboarding new contributors to coding conventions +## Scope Boundaries + +Activate this skill for: +- descriptive naming +- immutability defaults +- readability, KISS, DRY, and YAGNI enforcement +- error-handling expectations and code-smell review + +Do not use this skill as the primary source for: +- React composition, hooks, or rendering patterns +- backend architecture, API design, or database layering +- domain-specific framework guidance when a narrower ECC skill already exists + ## Code Quality Principles ### 1. Readability First