-
Notifications
You must be signed in to change notification settings - Fork 15
Add AGENTS.md file #22
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
subtleGradient
wants to merge
2
commits into
ansilove:master
Choose a base branch
from
effect-native:agents-md
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| # Repository Guidelines | ||
|
|
||
| ## Project Structure & Module Organization | ||
| libansilove is a C library that converts ANSI and related art files to PNG. Core headers live in `include/`, while the implementation sits in `src/` with `loaders/` containing format-specific decoders and `fonts/` bundling built-in typefaces. Cross-platform fallbacks are under `compat/`. The `example/` directory shows how to invoke the API end-to-end, and `man/` provides installed manual pages. Dedicated fuzzing harnesses reside in `fuzz/`; build them only when running sanitizer-heavy tests. | ||
|
|
||
| ## Build, Test, and Development Commands | ||
| - `cmake -S . -B build -DCMAKE_BUILD_TYPE=Release`: configure the project after installing GD headers and libs. | ||
| - `cmake --build build`: compile shared and static variants of the library. | ||
| - `cmake --build build --target install`: install artifacts into the default prefix. | ||
| - `cmake -S fuzz -B fuzz-build`: set up clang-based libFuzzer targets. | ||
| - `cmake --build fuzz-build`: produce fuzz binaries such as `ansi` and `tundra`. | ||
|
|
||
| ## Coding Style & Naming Conventions | ||
| - Target C99 with the default warning set (`-Wall -Wextra -pedantic`). | ||
| - Indent with tabs for blocks; align wrapped parameters using spaces as needed, and avoid trailing whitespace. | ||
| - Public APIs stay in `include/ansilove.h` and use the `ansilove_*` prefix; internal helpers remain lowercase with underscores and `static` linkage. | ||
| - Mirror existing filenames (`loadfile.c`, `savefile.c`) when adding new modules or loaders. | ||
|
|
||
| ## Testing Guidelines | ||
| - There is no unit-test harness; validate behavior with the example app and fuzzers. | ||
| - After building, run `build/example/ansilove_example <input.ans>` to confirm PNG output. | ||
| - For fuzzing, execute `./fuzz-build/ansi -runs=10000 corpus/` (seed the corpus with representative art files). Investigate sanitizer reports immediately and add reproducer samples. | ||
| - Ensure new formats or options ship with updated example inputs or fuzz seeds that exercise the paths. | ||
|
|
||
| ## Commit & Pull Request Guidelines | ||
| - Commit messages follow sentence case with concise statements ending in a period (for example, `Update ChangeLog.`). | ||
| - Keep functional changes and formatting adjustments in separate commits and ensure files build before pushing. | ||
| - Pull requests should summarize the change, call out impacted loaders, and link tracking issues. Note which build or fuzz commands were run, and attach PNG outputs or screenshots when visual diffs help reviewers. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| AGENTS.md | ||
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nitpick] This paragraph is extremely long and dense, making it difficult to read and understand. Consider breaking it into multiple sentences or using bullet points to improve readability.