Skip to content

Add AGENTS.md, docs/ governance set, and CVE directory override#4

Merged
Y4tacker merged 1 commit into
mainfrom
codex/add-agents.md-and-documentation-structure
Mar 25, 2026
Merged

Add AGENTS.md, docs/ governance set, and CVE directory override#4
Y4tacker merged 1 commit into
mainfrom
codex/add-agents.md-and-documentation-structure

Conversation

@Y4tacker

@Y4tacker Y4tacker commented Mar 25, 2026

Copy link
Copy Markdown
Owner

Motivation

  • Establish a short global entrypoint that guides contributors and agents where to find authoritative rules and where to land changes.
  • Move detailed policy and quality rules into a single-source docs/ area so global guidance remains compact and discoverable.
  • Provide a directory-level override for CVE reproduction notes so local exceptions and landing rules are captured without polluting global policy.

Description

  • Add a concise root map AGENTS.md that defines repository goals, rule priority (AGENTS.mdAGENTS.override.mddocs/), a default workflow, quick decision pointers, and minimal hard rules.
  • Add a docs/ rule set with index docs/README.md and thematic documents: docs/DESIGN.md, docs/RELIABILITY.md, docs/SECURITY.md, docs/PRODUCT_SENSE.md, docs/QUALITY_SCORE.md, docs/PLANS.md, and docs/FRONTEND.md.
  • Add 16.漏洞复现/AGENTS.override.md to capture the directory's scope, local hard rules for reproductions, and preferred change landing locations.
  • Files were created under the repository tree and populated with the described guidance and templates for contributors.

Testing

  • Verified presence of the new files and directory structure using find and listing commands, and confirmed the expected files exist (AGENTS.md, files under docs/, and 16.漏洞复现/AGENTS.override.md). — succeeded.
  • Inspected file contents with nl/file display to confirm each document contains its intended sections and headings (quick content assertions). — succeeded.
  • Performed repository-level checks to ensure the new documentation files are present in the working tree and contain the described entries. — succeeded.

Codex Task


Note

Low Risk
Low risk documentation-only change that adds repository governance/quality guidance and a directory-specific override; no runtime code or security-sensitive logic is modified.

Overview
Adds a new root AGENTS.md as the repository’s global navigation and default workflow, including rule precedence (AGENTS.mdAGENTS.override.mddocs/) and quick pointers for where changes should land.

Introduces a docs/ single-source rule set (docs/README.md plus design/reliability/security/quality/plan/product/front-end guidance) to centralize detailed standards.

Adds 16.漏洞复现/AGENTS.override.md to define the CVE reproduction directory’s scope and local hard rules (required environment/version info, troubleshooting, and legal-use warnings) and to standardize where new CVE notes should be created/updated.

Written by Cursor Bugbot for commit af88f96. This will update automatically on new commits. Configure here.

@Y4tacker Y4tacker merged commit 736f534 into main Mar 25, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant