Skip to content

Commit 5532191

Browse files
authored
Integrate AGENTS.md (#203)
From https://agents.md to integrate an open-source format for guiding coding agents. The main concept is basically this: * `README.md`: designed for humans. * `AGENTS.md`: designed for AI coding agents.
1 parent 18f1128 commit 5532191

2 files changed

Lines changed: 40 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Docbuild Project
2+
3+
This document outlines key information about the `docbuild` project to assist AI agents and developers.
4+
5+
## Purpose of this Project (Docbuild)
6+
7+
Docbuild builds documentation from DocBook 5/ASCIIDoc, manages XML configs, clones repos, runs `daps`, handles metadata and syncing deliverables.
8+
9+
## Repository Facts
10+
11+
* **Python Version:** >= 3.12
12+
* **Package Manager:** `uv` (Astral)
13+
* **Key Directories:**
14+
* `src/`: Source code
15+
* `tests/`: Test suite (pytest)
16+
* `.github/workflows/`: CI/CD configurations
17+
* **CLI Entry Point:** `docbuild` (file `src/docbuild/__main__.py`)
18+
* **Documentation:*** https://opensuse.github.io/docbuild/
19+
20+
## Setup
21+
22+
1. Create a virtual environment with `uv venv`
23+
2. Install dependencies: `uv sync --frozen --group devel`
24+
25+
## Testing with `uv`
26+
27+
To run tests in this environment, use the following commands:
28+
29+
* **Run complete test suite:**
30+
31+
```bash
32+
uv run --frozen pytest
33+
```
34+
35+
* **Run single test file:**
36+
37+
```bash
38+
uv run --frozen pytest tests/path/to/test_file.py
39+
```

changelog.d/203.infra.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Add :file:`AGENTS.md` for guiding coding agents.

0 commit comments

Comments
 (0)