From 51f6e3466418a719f2d0c5626a6fe946bde3923c Mon Sep 17 00:00:00 2001 From: shokollm <270575765+shokollm@users.noreply.github.com> Date: Mon, 30 Mar 2026 14:52:57 +0000 Subject: [PATCH] docs #24: Add HELLO.md for new contributors --- HELLO.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 HELLO.md diff --git a/HELLO.md b/HELLO.md new file mode 100644 index 0000000..7847ef4 --- /dev/null +++ b/HELLO.md @@ -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! -- 2.49.1