Skip to content

Commit b45600c

Browse files
authored
Merge pull request #9 from All-Hands-AI/openhands/create-repo-md
Create repo.md microagent with linting and documentation guidelines
2 parents e99ba27 + f164355 commit b45600c

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

.openhands/microagents/repo.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Repository Purpose
2+
This is the OpenHands CLI - a command-line interface for OpenHands AI Agent with Terminal User Interface (TUI) support. It provides a standalone executable that allows users to interact with OpenHands through a terminal interface.
3+
4+
# Setup Instructions
5+
To set up the development environment:
6+
1. Install dependencies: `make install-dev`
7+
2. Install pre-commit hooks: `make install-pre-commit-hooks`
8+
9+
10+
11+
# Development Guidelines
12+
13+
## Linting Requirements
14+
**Always run lint before committing changes.** Use `make lint` to run all pre-commit hooks on all files. The project uses:
15+
16+
## Documentation Guidelines
17+
- **Do NOT send summary updates in the README.md** for the repository
18+
- **Do NOT create .md files in the root** of the repository to track or send updates
19+
- Only make documentation changes when explicitly requested to

0 commit comments

Comments
 (0)