docs #24: Add HELLO.md for new contributors #26
43
HELLO.md
Normal file
43
HELLO.md
Normal file
@@ -0,0 +1,43 @@
|
||||
# Hello, Contributor! 👋
|
||||
|
||||
Welcome to **Kugetsu** — an agent orchestration system for parallel task execution.
|
||||
|
||||
## Quick Start
|
||||
|
||||
1. **Clone the repo**
|
||||
```bash
|
||||
git clone https://git.fbrns.co/shoko/kugetsu.git
|
||||
cd kugetsu
|
||||
```
|
||||
|
||||
2. **Read the docs**
|
||||
- [README](./README.md) — Project overview
|
||||
- [Architecture](./docs/kugetsu-architecture.md) — System design
|
||||
- [Hermes Setup](./docs/hermes-setup.md) — Agent framework setup
|
||||
|
||||
3. **Pick an issue**
|
||||
- Browse [open issues](https://git.fbrns.co/shoko/kugetsu/issues)
|
||||
- Look for issues labeled `good first issue` or `help wanted`
|
||||
|
||||
4. **Contribute**
|
||||
- Create a branch: `git checkout -b docs/issue-{N}-title main`
|
||||
- Make your changes
|
||||
- Open a PR against `main`
|
||||
|
||||
## Workflow
|
||||
|
||||
```
|
||||
You (Executive)
|
||||
└── PM Agent (coordinates)
|
||||
├── Coding Agent A → Issue 1 → PR
|
||||
├── Coding Agent B → Issue 2 → PR
|
||||
└── ...
|
||||
```
|
||||
|
||||
For details, see [Subagent Workflow](./docs/SUBAGENT_WORKFLOW.md).
|
||||
|
||||
## Questions?
|
||||
|
||||
Open an issue or check the [documentation](./docs/).
|
||||
|
||||
Happy contributing!
|
||||
Reference in New Issue
Block a user