|
| 1 | +# AGENTS.md |
| 2 | + |
| 3 | +Guidance for coding agents working in this repository. |
| 4 | + |
| 5 | +## Project overview |
| 6 | + |
| 7 | +This is a test fixture repository, not a real project. Its README states that it |
| 8 | +exists to exercise Sourcegraph batch changes. It contains only Markdown files |
| 9 | +plus a placeholder CI workflow — there is no application code. |
| 10 | + |
| 11 | +Some files exist specifically to test text-handling edge cases: `TRAILING.md` |
| 12 | +and `NONTRAILING.md` differ in whether the file ends with a trailing newline. |
| 13 | + |
| 14 | +## Repository layout |
| 15 | + |
| 16 | +Flat, single level — there are no source directories. |
| 17 | + |
| 18 | +| Path | Purpose | |
| 19 | +| --- | --- | |
| 20 | +| `README.md` | Placeholder; states the repo is for testing batch changes | |
| 21 | +| `CONTRIBUTING.md` | Heading only, no content | |
| 22 | +| `CHANGELOG.md` | Single trivial entry | |
| 23 | +| `ANOTHER.md`, `RANDOM.md`, `TESTING.md`, `TESTINGGG.md` | Placeholder Markdown | |
| 24 | +| `TRAILING.md`, `NONTRAILING.md` | Fixtures for trailing-newline behavior | |
| 25 | +| `.github/workflows/blank.yml` | Unmodified GitHub Actions starter template | |
| 26 | +| `.gitignore` | Ignores `.DS_Store` and `.env` | |
| 27 | + |
| 28 | +## Setup, build, test, lint |
| 29 | + |
| 30 | +There is nothing to set up, build, test, or lint. The repository has no package |
| 31 | +manager manifest, no Makefile, and no linter configuration. Do not add build |
| 32 | +tooling unless a task explicitly asks for it. |
| 33 | + |
| 34 | +`.github/workflows/blank.yml` is the default GitHub Actions starter workflow; it |
| 35 | +echoes a greeting and validates nothing. A green CI run here does not mean a |
| 36 | +change is correct. |
| 37 | + |
| 38 | +## Conventions |
| 39 | + |
| 40 | +- Content is plain Markdown. No style guide or linter is enforced. |
| 41 | +- No formatter runs over this repository, so avoid reflowing or reformatting |
| 42 | + files you were not asked to change. |
| 43 | + |
| 44 | +## Gotchas |
| 45 | + |
| 46 | +- Preserve each file's existing trailing-newline state. `TRAILING.md` and |
| 47 | + `NONTRAILING.md` are fixtures for exactly this; normalizing them defeats their |
| 48 | + purpose. |
| 49 | +- Scope edits narrowly. Because the files are near-identical placeholder text, a |
| 50 | + broad find-and-replace can easily touch fixtures a task did not intend to |
| 51 | + modify. |
| 52 | +- Treat this repository as disposable test data. Do not rely on anything here as |
| 53 | + an example of production conventions. |
0 commit comments