file-headers

Featured

MANDATORY for every coding agent (Claude Code, Codex, or any other) on every change-set — every applicable source file the agent creates or updates MUST start with the project's copyright/authorship header (file overview + exact author line). Use automatically whenever writing a new file or editing an existing one; do not wait to be asked. Covers JS/TS/TSX/CJS/MJS, Python, shell, and CSS. Includes the audit script to verify repo-wide compliance.

API & Backend 1,016 stars 239 forks Updated today MIT

Install

View on GitHub

Quality Score: 93/100

Stars 20%
100
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# File Headers — Copyright Comment + File Overview Every applicable source file in this repository starts with a header comment containing a **file overview** and the **exact author line**: ``` @author Son Nguyen <hoangson091104@gmail.com> ``` The name and email must be exactly as above — no variations, no substitutions, no other names. This applies to **every coding agent** working in this repo (Claude Code, Codex, or any other tool): when you **create** a new applicable file, write the header first; when you **update** an existing applicable file that is missing the header, add it as part of the same change. ## Applicable files | Included | Excluded | | -------- | -------- | | `*.js`, `*.ts`, `*.tsx`, `*.cjs`, `*.mjs` | anything under `node_modules/`, `dist/`, `build/`, `data/`, `.worktrees/` | | `*.py`, `*.sh` | vendored/minified files (`*.min.js`, `wiki/mermaid.min.js`) | | `*.css` | generated files (`wiki/i18n-content.js` — carries its own AUTO-GENERATED banner) | | | snapshots (`__snapshots__/`), lockfiles, JSON/YAML/Markdown | ## Header formats by file type **JS / TS / TSX — server & scripts style** (overview inline in `@file`): ```js /** * @file One-to-few-sentence overview of what this file does and why it * exists. Mention the key contracts or invariants the file owns. * @author Son Nguyen <hoangson091104@gmail.com> */ ``` **JS / TS / TSX — client style** (`@file` name + `@description` overview), used under `client/src/`: ```ts /** * @file ComponentNa...

Details

Author
hoangsonww
Repository
hoangsonww/Claude-Code-Agent-Monitor
Created
6 months ago
Last Updated
today
Language
TypeScript
License
MIT

Integrates with

Bundled in these plugins

Similar Skills

Semantically similar based on skill content — not just same category

Code & Development Listed

coding-standards

Use when writing, editing, or reviewing code and its inline documentation — module headers, inline comments, docstrings, doc comments — in any language or stack

3 Updated today
metraton
Code & Development Listed

coding

The user's coding and docs conventions and taste. Load FIRST, at the start of any task that touches code or docs.

8 Updated today
sherifabdlnaby
Code & Development Featured

code-overview

Produces a human-readable, progressive-disclosure overview of unfamiliar code or a pull request's changes — why it exists (the real problem it solves or goal it serves for the business or a user), and from there what it does, how it flows, and where to start — so you can get up to speed before working on or reviewing it. Use when you want to understand, get oriented in, make sense of, explain, or get up to speed on a chunk of code, a file, a directory, a symbol, or a PR's changes. Writes the overview to a scratch file and changes no code. Does not review code quality or raise findings — use code-review for auditing changes or post-code-review-to-pr for posting them. Does not produce durable feature or system documentation — use project-documentation. Does not assess architecture or structural risk — use architectural-analysis. Does not diagnose bugs or root-cause failures — use investigate. Does not pace a person through the code one step at a time in conversation — use code-walkthrough.

273 Updated 2 days ago
testdouble