contributor-workflow

Contribution rules for docs.linea.build, a documentation website. They cover the required issue-first process, redirects for moved pages, generated content, and checking facts against reliable sources.

In plain words
What is it for?
Use them when contributing documentation, opening a pull request, moving or deleting pages, editing protocol content, or working with generated API pages.
Why use it?
They prevent undocumented changes, broken links, accidental edits to generated files, and unsupported technical claims from reaching the documentation project.

Cursor rule for Cursor

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add rules/consensys/doc.linea/contributor-workflow
Clone the repo
git clone --depth 1 https://github.com/Consensys/doc.linea

Made for: Cursor.

Per session 448 This file is loaded in full into every session.
When invoked 448 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
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 $0.00448 $0.00448
Opus 5 $0.00224 $0.00224
Sonnet 5 $0.00090 $0.00090
Haiku 4.5 $0.00045 $0.00045

Measured yesterday against content hash 220c6df7be2e, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

contributor-workflow 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 yesterday.

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.

.cursor/rules/contributor-workflow.mdc · 50 lines

What it actually says

Contributor workflow

See CONTRIBUTING.md for the full contribution workflow. The rules below highlight requirements that are most often missed.

Issue first

Open an issue describing the change before starting work on it, and link the issue from the pull request. Use the templates in .github/ISSUE_TEMPLATE/ (bug report, enhancement, partner contribution). This matters especially for ecosystem/partner contributions: filing an issue first makes it much easier for the docs team to process the contribution.

Redirects

Every deleted, renamed, or moved page needs a matching entry in redirects.json, and every internal link that pointed at the old path needs updating. onBrokenLinks is configured to fail the build, so a missed redirect or stale link breaks CI, not just the reader's experience.

Auto-generated content

docs/api/linea-smart-contracts/ is automatically generated. Don't hand-edit it; change the generator/source instead.

Factual accuracy

Don't state as fact any protocol behavior, API parameter, CLI option, or return value you haven't verified against source code, a spec, or a published reference. If uncertain, use the [VERIFY] marker (editorial-voice.mdc) rather than guessing.

Ecosystem contributions

Contributions from ecosystem projects (dapps, libraries, tooling) should stay informative rather than promotional. See the ecosystem-contribution guidance in CONTRIBUTING.md. The contributor is responsible for keeping their project's information current after merge.

Pull requests

  • Follow Conventional Commits (docs: clarify bridging guide); commitlint enforces this.
  • Run npm run lint and npm run typecheck locally before pushing.
  • Return to open PRs for review feedback. PRs inactive for three months after review get closed (see CONTRIBUTING.md).
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. yesterday First seen · 50 lines · 448 tokens per session scan A 220c6df7be2e

Subscribe to this mod's changes

contributor-workflow is a cursor rule published in the GitHub repository Consensys/doc.linea (474 stars, last pushed 4d ago), licensed Apache-2.0. It adds 448 tokens to every session, about $0.0022 per session on Opus 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.