From eb842ea34fa1d51f1044d28facfd44deb75482e2 Mon Sep 17 00:00:00 2001
From: AlexLarra <alexander.larrazabal@crisalix.com>
Date: Fri, 3 Apr 2026 20:40:56 +0200
Subject: [PATCH] Add initial documentation for Internator project

- Created AGENTS.md to provide an overview of the Internator Ruby CLI gem
- Included details on project overview, key components, development guidelines, and configuration options.
---
 AGENTS.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 AGENTS.md

diff --git a/AGENTS.md b/AGENTS.md
new file mode 100644
index 0000000..1ecd089
--- /dev/null
+++ b/AGENTS.md
@@ -0,0 +1,27 @@
+# Guide for AI Agents
+
+## Project Overview
+
+Internator is a Ruby CLI gem that automates iterative pull request improvements using the `opencode` CLI. It cycles through objectives, makes incremental changes, automatically commits and pushes each update, and optionally waits between iterations.
+
+## Key Components
+
+- **CLI (`lib/internator/cli.rb`)**: Main entry point handling argument parsing, git operations, and the iteration loop
+- **OpencodeService (`lib/internator/opencode_service.rb`)**: Executes `opencode run` commands with proper shell escaping
+
+## Development Guidelines
+
+### Code Style
+
+1. **No excessive comments**: If the method name is self-explanatory, comments are unnecessary
+2. **No trailing newlines**: Treat files as if saved with Vim's `set binary` and `set noeol`
+3. **Ruby conventions**: Follow standard Ruby style guidelines
+
+## Configuration
+
+Users can customize behavior via `~/.internator_config.yml`:
+
+```yaml
+instructions: |
+  Custom instructions here...
+```