Skip to content

docs: add gix dependency preference to AGENTS.md #15

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.

Sign up for GitHub

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

Merged
krlvi merged 1 commit into from
Mar 31, 2026
Merged

docs: add gix dependency preference to AGENTS.md #15

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@ This is a reference implementation of the gmeta spec ([docs](https://schacon.git
- Prefer guard clauses (early returns) over nested `if` blocks.
- Prefer iterators/combinators over manual loops. Use `Cow<'_, str>` when allocation is conditional.

## Dependencies

- **Use `gix` (gitoxide), not `git2` (libgit2).** `gix` is the preferred Git library for this project. Do not introduce `git2` dependencies or suggest `git2`-based solutions. If existing code uses `git2`, prefer migrating it to `gix` when touching that code.

## Architecture and Design

- For code that you create, **always** include doc comments for all public functions, structs, enums, and methods and also document function parameters, return values, and errors.
Expand Down
Loading