AGENTS.md#46
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation to establish repository guidelines and development practices. The main purpose is to provide comprehensive development guidelines for contributors to the AnsiLove/C project.
- Creates a new AGENTS.md file containing detailed development guidelines
- Adds a CLAUDE.md file that references AGENTS.md
- Establishes standards for project structure, build processes, coding style, testing, and contribution workflows
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| AGENTS.md | Main documentation file containing comprehensive development guidelines covering project structure, build commands, coding standards, testing practices, and PR guidelines |
| CLAUDE.md | Simple reference file pointing to AGENTS.md |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| @@ -0,0 +1 @@ | |||
| AGENTS.md No newline at end of file | |||
There was a problem hiding this comment.
[nitpick] The CLAUDE.md file contains only a reference to AGENTS.md without any context or explanation. Consider adding a brief description of what AGENTS.md contains or why someone should consult it.
| AnsiLove/C keeps the CLI in `src/` (`ansilove.c`, `sauce.c`, helpers such as `strtolower.c`). Portable fallbacks sit in `compat/` and are pulled in by `CMakeLists.txt` when the host lacks pledge or strtonum. Test fixtures for the regression suite live in `tests/`, and user-facing docs live in `man/`, `examples/`, and `ChangeLog`. Add new sources next to their headers and register them in `CMakeLists.txt` so every build configuration picks them up. | ||
|
|
There was a problem hiding this comment.
[nitpick] This paragraph is very dense and difficult to parse. Consider breaking it into a bulleted list to improve readability, with separate points for source code location, portable fallbacks, test fixtures, and documentation.
| AnsiLove/C keeps the CLI in `src/` (`ansilove.c`, `sauce.c`, helpers such as `strtolower.c`). Portable fallbacks sit in `compat/` and are pulled in by `CMakeLists.txt` when the host lacks pledge or strtonum. Test fixtures for the regression suite live in `tests/`, and user-facing docs live in `man/`, `examples/`, and `ChangeLog`. Add new sources next to their headers and register them in `CMakeLists.txt` so every build configuration picks them up. | |
| The project structure is organized as follows: | |
| - The CLI and main helpers are in `src/` (e.g., `ansilove.c`, `sauce.c`, `strtolower.c`). | |
| - Portable fallbacks are in `compat/` and are included by `CMakeLists.txt` when the host lacks features like `pledge` or `strtonum`. | |
| - Test fixtures for the regression suite are in `tests/`. | |
| - User-facing documentation is in `man/`, `examples/`, and `ChangeLog`. | |
| Add new sources next to their headers and register them in `CMakeLists.txt` so every build configuration picks them up. |
https://AGENTS.md