Skip to content

Commit c37c3f2

Browse files
Merge pull request #8 from tracebit-com/codex/document-usage-instructions-for-repo
Add AGENTS.md with guidelines for updating README.MD
2 parents ba7cb39 + 9e5caaf commit c37c3f2

1 file changed

Lines changed: 37 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# AGENTS.md
2+
3+
## Purpose
4+
This repository is a curated list (`README.MD`) of deception-related resources. Future Codex runs should prioritize **accuracy over volume** and avoid speculative edits.
5+
6+
## Rules for updating `README.MD`
7+
1. **Never fabricate details**
8+
- Do not invent titles, dates, summaries, authors, venues, or claims.
9+
- If a source page/PDF cannot be accessed well enough to verify facts, do **not** add or modify that entry.
10+
11+
2. **Year must be verified, not inferred loosely**
12+
- Confirm the year from the source itself (publication date, paper metadata, DOI page, arXiv record, conference page, etc.).
13+
- Do not rely only on surrounding list context or assumptions.
14+
15+
3. **Default placement rule: append to the end of the relevant subsection**
16+
- Unless the user explicitly asks for reordering/sorting, add new bullets to the **end** of that subsection.
17+
- Do not insert a new entry between existing items that share the same year unless explicitly asked to reorder.
18+
19+
4. **Keep existing style consistent**
20+
- Format: `- [Title](URL) (YEAR) - short description.` for paper-like entries.
21+
- Use concise, factual descriptions based on verifiable source content.
22+
23+
5. **Avoid silent quality regressions**
24+
- Do not duplicate an existing link/resource.
25+
- Ensure the resource goes in the correct section (`Articles`, `Research`, `Talks`, etc.).
26+
- Preserve markdown structure and headings.
27+
28+
## PR and commit title conventions
29+
- For paper additions, keep titles simple and consistent: `Add Paper - <short details on paper>`.
30+
- Avoid overly long or quirky PR/commit titles; prefer concise, descriptive wording.
31+
32+
## Pre-commit checklist (required)
33+
- Verify each changed/added URL and title are real.
34+
- Verify each changed/added year is correct.
35+
- Confirm new bullets were appended (unless user requested different ordering).
36+
- Check for accidental duplicates.
37+
- Run: `git diff -- README.MD` and sanity-check every changed line.

0 commit comments

Comments
 (0)