Skip to content

feat: Create AGENTS.md for repository guidelines #2

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

Draft
open-swe wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

feat: Create AGENTS.md for repository guidelines #2

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5f9ff0d
Apply patch [skip ci]
open-swe Aug 18, 2025
1c34b85
Apply patch [skip ci]
open-swe Aug 18, 2025
cd0989d
Empty commit to trigger CI
open-swe Aug 18, 2025
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
28 changes: 28 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<general_rules>
- Use `pnpm` as the package manager for this project.
- All code, comments, and documentation must be written in English.
- Maintain code quality by running the linter and formatter before committing changes.
- `pnpm run lint`: Lints all TypeScript files in the `src/` directory.
- `pnpm run lint:fix`: Automatically fixes linting errors where possible.
- `pnpm run format`: Formats the code using Prettier.
</general_rules>
<repository_structure>
- The repository contains a Telegram bot that integrates with the Claude Code SDK.
- The main application source code is located in the `src/` directory.
- The entry point for the application is `src/main.ts`.
- The architecture is modular:
- `src/handlers/`: Contains the core logic for Claude integration (`claude.ts`) and Telegram coordination (`telegram.ts`).
- `src/storage/`: Implements a storage abstraction layer that supports both Redis and in-memory backends for session management.
- `src/services/`: Contains business logic, including a permission management system for tool usage.
- A separate Cloudflare Workers application is located in the `workers/` directory. This worker provides a diff viewer service and has its own `package.json` and dependencies.
</repository_structure>
<dependencies_and_installation>
- To install dependencies for the main bot, run `pnpm install` in the root directory.
- The Cloudflare worker in the `workers/` directory has its own set of dependencies. To install them, navigate to the `workers/` directory and run `pnpm install`.
</dependencies_and_installation>
<testing_instructions>
- There is currently no test framework configured for this project.
</testing_instructions>
<pull_request_formatting>
</pull_request_formatting>