Skip to content

Add AGENTS with testing instructions #109

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

Merged
merged 1 commit into from
Jul 29, 2025

Conversation

pykello
Copy link
Collaborator

@pykello pykello commented Jul 29, 2025

Summary

  • document contribution rules in new AGENTS.md

Testing

  • cargo fmt --all -- --check
  • cargo clippy --all-targets --all-features -- -D warnings
  • cargo test
  • cargo test --features disable-isal-crypto

https://chatgpt.com/codex/tasks/task_e_68895123bef48327ab1f0b390aa36811

Copy link

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Greptile Summary

This PR adds a new AGENTS.md file that establishes contribution guidelines for the ubiblk repository. The file provides a simple three-step checklist for contributors to follow before submitting changes:

  1. Code formatting validation using cargo fmt --all -- --check
  2. Linting with cargo clippy --all-targets --all-features -- -D warnings
  3. Comprehensive testing including both standard tests (cargo test) and tests with the optional isa-l_crypto dependency disabled (cargo test --features disable-isal-crypto)

This documentation directly mirrors the automated checks performed in the existing GitHub Actions workflow (.github/workflows/release.yaml), ensuring contributors can locally validate their changes against the same standards enforced by CI. The inclusion of the disable-isal-crypto feature testing aligns with the project's Cargo.toml configuration, which defines this as an optional feature that disables AES and XTS-mode encryption dependencies. This creates a standardized development workflow that helps prevent CI failures and streamlines the contribution process.

Confidence score: 5/5

  • This PR is extremely safe to merge as it only adds documentation without modifying any code functionality.
  • The commands documented are already established practices in the CI workflow, making this purely a documentation improvement.
  • No files need additional attention - this is a straightforward documentation addition.

1 file reviewed, no comments

Edit Code Review Bot Settings | Greptile

@pykello pykello merged commit 666aba4 into main Jul 29, 2025
2 checks passed
@pykello pykello deleted the codex/add-proper-agent-documentation branch July 29, 2025 23:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant