Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 65 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# AGENTS.md

This repository contains the GAP package `AutoDoc`.

## AI disclosure

Any use of AI tools for preparing code, documentation, tests, commit messages,
pull requests, issue comments, or reviews for this repository must be
disclosed. Include a brief note saying which AI tool was used and what kind of
assistance it provided. Add the AI tool as a Git co-author on all commits
created by that tool.

## Repository layout

- `PackageInfo.g`: package metadata, including the current version and manual
settings.
- `makedoc.g`: entry point for rebuilding the manual.
- `regen_tests.g`: entry point for regenerating test data.
- `tst/`: package test suite. Run `tst/testall.g` for the full suite, or a
single `.tst` file for one test.
- `README.md`: top-level package overview.

## Common commands

Run all commands from the repository root.

### Build the manual

```sh
gap -q --packagedirs . makedoc.g
```

### Run all tests

```sh
gap -q --packagedirs . tst/testall.g
```

### Run one test

```sh
gap -q --packagedirs . tst/misc.tst
```

Replace `tst/misc.tst` with any other test file in `tst/` as needed.

### Regenerate the tests

```sh
gap -q --packagedirs . regen_tests.g
```

## Commit messages and pull requests

When writing commit messages, use the title format `component: Brief summary`.
In the body, give a brief prose summary of the purpose of the change. Do not
specifically call out added tests, comments, documentation, and similar
supporting edits unless that is the main purpose of the change. Do not include
the test plan unless it differs from the instructions in this file. If the
change fixes one or more issues, add `Fixes #...` at the end of the commit
message body, not in the title.

Pull requests should follow the same style: a short summary up top, concise
prose describing the change, issue references when applicable, and an explicit
AI-disclosure note if AI tools were used.