diff options
Diffstat (limited to '.cursor/rules/hybbx-project.mdc')
| -rw-r--r-- | .cursor/rules/hybbx-project.mdc | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/.cursor/rules/hybbx-project.mdc b/.cursor/rules/hybbx-project.mdc new file mode 100644 index 0000000..df97cf5 --- /dev/null +++ b/.cursor/rules/hybbx-project.mdc @@ -0,0 +1,35 @@ +--- +description: HyBBX project conventions for all work in this repo +alwaysApply: true +--- + +# HyBBX project rules + +Read [AGENTS.md](../../AGENTS.md) and [docs/DEVELOPMENT.md](../../docs/DEVELOPMENT.md). + +## Product + +Plugin-only session daemon; Main + Secondary HBX topology ([TOPOLOGY.md](../../docs/TOPOLOGY.md)). **v2.0.0**. Technical docs in `docs/`; root README is short overview. + +## Code + +- C99, `hybbx_` prefix, `hybbx_result_t` errors +- Core = sessions + HBX/TCP only — no wire-protocol parsing in `src/core/` +- Plugins in `plugins/`; booleans via `hybbx_parse_bool()` +- Minimal scope; [limits.h](../../include/hybbx/limits.h) +- **POSIX+ / portability:** shared code stays POSIX-friendly; keep `*BSD` (FreeBSD, NetBSD, OpenBSD, …) and AmigaOS 3.9+ compatible; platform code behind `_WIN32` / `__AMIGA__` guards or dedicated files + +## Docs + +- **Technical only** — operator/INI → MANUAL.md + `share/*.ini.example`; commands → COMMANDS.md + commands.yaml; build → BUILD.md +- No planning, roadmap, feature-status, or release-note docs +- **Current version only** — no prior-version references in docs, `text/`, or user-facing comments +- **As-is software** — compact prose; no upgrade/migration/history sections +- **Linux-based operator docs** — `docs/`, `text/`, README, share examples. `HTTPD_DOCROOT`, `systemctl`, `ss`. Platform targets only in `docs/PLATFORMS.md` — own sections per OS (Linux, AmigaOS 3.9+, *BSD, MacOS X+, Windows 10+, …); spell **MacOS**, not macOS +- **POSIX+ / portability** — `*BSD` (FreeBSD, NetBSD, OpenBSD, …) and AmigaOS 3.9+ stay compatible; shared code easy to port; no Linux-only APIs in core without guards + +## Git + +- **Identity only:** `ngteq <info@un1t.me>` — no other author name or email in this repo (`.git/config`: `user.name`, `user.email`) +- **Push only:** SSH `~/.ssh/id_ed25519_ngteq` → `git@github.com:ngteq/hyBBX.git` +- No commit/push unless the user asks |