roadmap-skill: Instructions file for Codex

AGENTS.md

roadmap-skill AGENTS.md is an instructions file for Codex, OpenCode from shiquda/roadmap-skill. It costs 1,828 tokens per session, scanned A, original, MIT.

A project instruction document that records contribution rules, including English Conventional Commit messages, common build commands, and testing or type-checking commands. Conventional Commits use prefixes such as feat, fix, and docs to describe changes.

In plain words
What is it for?
Use it as a reference when writing commits, running development or build commands, checking types, and following the project’s documented workflow.
Why use it?
It gives coding agents and contributors a shared set of project conventions. This reduces inconsistent commit messages and makes the expected development and verification commands easy to find.

Instructions file for CodexOpenCode

Written for Codex and OpenCode: the file is AGENTS.md.

This is shiquda/roadmap-skill's own configuration. It tells Codex and OpenCode how to work on roadmap-skill itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything roadmap-skill configures →

Needs its repository: it reads a path above its own folder, which exists only inside the repository. The line is import { Project } from '../models/index.js';.

Reuse

Borrowing it

Nothing to install: this file belongs to shiquda/roadmap-skill. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/shiquda/roadmap-skill/main/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/shiquda/roadmap-skill

Made for: Codex, OpenCode.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for roadmap-skill AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/shiquda/roadmap-skill/agents-md/github.svg)](https://agentmods.dev/instructions/shiquda/roadmap-skill/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/shiquda/roadmap-skill/agents-md"><img src="https://agentmods.dev/badge/instructions/shiquda/roadmap-skill/agents-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for roadmap-skill AGENTS.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/shiquda/roadmap-skill/agents-md"><img src="https://agentmods.dev/badge/instructions/shiquda/roadmap-skill/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 1,828 This file is loaded in full into every session.
When invoked 1,828 The same file — it is already loaded in full.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.01828 $0.01828
Opus 5.5 $0.00731 $0.00731
Sonnet 5.5 $0.00366 $0.00366
Haiku 4.5 $0.00183 $0.00183

Measured 1mo ago against content hash 793690cdeb53, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

roadmap-skill AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 1mo ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 282 lines

How it starts

The opening of the file, as written. The whole thing — 282 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Project Guidelines

Git Commit Messages

All commit messages must be written in English.

Format

Follow Conventional Commits specification:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Types

  • feat: A new feature
  • fix: A bug fix
  • docs: Documentation only changes
  • style: Changes that do not affect the meaning of the code (white-space, formatting, etc)
  • refactor: A code change that neither fixes a bug nor adds a feature
  • perf: A code change that improves performance
  • test: Adding missing tests or correcting existing tests
  • chore: Changes to the build process or auxiliary tools

Examples

feat: add task priority sorting to kanban board

fix: resolve CI build failure by switching from Taobao registry to npm official registry

docs: update README with installation instructions

refactor(storage): simplify task update logic

Build & Test Commands

# Development
npm run dev              # Start development mode with watch

# Building
npm run build            # Full build (Node + Web)
npm run build:web        # Build only web frontend

# Type checking
npm run typecheck        # Run TypeScript type checking without emitting

# Testing
npm run test             # Run tests in watch mode
npm run test:unit        # Run unit tests once
npm run test:integration # Run integration tests once

# Run a single test file
npx vitest run tests/unit/storage.test.ts

# Run tests matching a pattern
npx vitest run --reporter=verbose --testNamePattern="createProject"

Code Style Guidelines

TypeScript

  • Target: ES2022 with NodeNext module resolution
  • Strict mode: Enabled - all strict TypeScript options must pass
  • Unused code: Not allowed (noUnusedLocals, noUnusedParameters)
  • Implicit returns: Not allowed (noImplicitReturns)

Imports & Modules

  • Use ES modules ("type": "module" in package.json)
  • Include .js extension in imports: import { foo } from './bar.js'
  • Prefer named imports over default imports
  • Group imports: built-ins → external → internal (separated by blank line)

Read the full file on GitHub · 282 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 1mo ago First seen · 282 lines · 1,828 tokens per session scan A 793690cdeb53

Subscribe to this mod's changes

roadmap-skill AGENTS.md is an instructions file published in the GitHub repository shiquda/roadmap-skill (82 stars, last pushed 7mo ago), licensed MIT. It adds 1,828 tokens to every session, about $0.0073 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other instructions, from other repositories