# AGENTS.md - Hyprscratch Development Guidelines
## Agent Interaction Guidelines
- Do not modify files or run commands unless explicitly told to do so.
- When asked for code, we are just brainstorming.
## Project Philosophy
- This project should add barely any overhead to the user's system and integrate well with Hyprland, almost as if it is a built-in feature.
- We try to keep the code simple in the sense that features are implemented just for our needs and we do not add dependencies unless it is for big things with a lot of pitfalls.
- We try not to add features that can be easily done with just the tools that Hyprland gives us.
## Build Commands
- `cargo build` - Compile the project
- `cargo build --release` - Compile optimized release build
- `cargo check` - Check code without building
## Test Commands
- `cargo test -- --test-threads=1` - Run all tests (single-threaded)
- `cargo test <test_name> -- --test-threads=1` - Run specific test (single-threaded)
- `cargo test -- --nocapture --test-threads=1` - Run tests with output (single-threaded)
## Lint & Format Commands
- `cargo clippy` - Run clippy linter
- `cargo fmt` - Format code with rustfmt
- `cargo fmt --check` - Check formatting without changes
## Code Style Guidelines
- **Naming**: snake_case for functions/variables, PascalCase for types, UPPER_SNAKE_CASE for constants
- **Error Handling**: Use `Result<T>` and `?` operator; use `unwrap_log!` macro for critical errors
- **Types**: Prefer `&str` over `String` for parameters; use `Option`/`Result` extensively
- **Collections**: Use `std::collections::HashMap` for key-value data
- **Pattern Matching**: Use `match` statements for complex logic
- **Iterators**: Leverage iterators and closures for data processing
- **Testing**: Use `#[cfg(test)]` modules; use `pretty_assertions` for better test output
- **Imports**: Group std imports first, then external crates, then local modules
- **Documentation**: No comments unless explicitly requested
## File Modification Guidelines
- **AGENTS.md Modifications**: This file should only be modified with explicit permission from the user
- **Code Generation Requests**: Any code generation request should be printed out first before implementation