summaryrefslogtreecommitdiff
path: root/.cursor/rules/hybbx-project.mdc
blob: df97cf5b46d3cb6d6720adb1a02fc3831838025a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
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
git clone -b <branch> https://cgit.mode42.com/<repo>.git
git clone -b <branch> git://cgit.mode42.com/<repo>.git

info@mode42.com