summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..1f90ae7
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,29 @@
+# Contributing
+
+**v2.0.0** · standards: [AGENTS.md](AGENTS.md), [docs/DEVELOPMENT.md](docs/DEVELOPMENT.md).
+
+```bash
+git clone <repository-url> && cd hyBBX
+./scripts/dev-setup.sh && ./scripts/hybbx.sh
+telnet 127.0.0.1 2323
+```
+
+## Git identity
+
+**Only** this identity — no alternatives:
+
+```
+user.name = ngteq
+user.email = info@un1t.me
+```
+
+Local `.git/config`. Push **only** via SSH `~/.ssh/id_ed25519_ngteq` to `git@github.com:ngteq/hyBBX.git`.
+
+## Pull requests
+
+- Small, focused diffs; Main/Secondary model unchanged unless discussed
+- Behaviour / INI change → [docs/MANUAL.md](docs/MANUAL.md) + `share/*.ini.example`
+- Entertain apps → plugin under `plugins/` only — [docs/ENTERTAIN.md](docs/ENTERTAIN.md)
+- Verify: `cmake --build build`; telnet session if session/core touched
+
+Issues: `.github/ISSUE_TEMPLATE/`.
git clone -b <branch> https://cgit.mode42.com/<repo>.git
git clone -b <branch> git://cgit.mode42.com/<repo>.git

info@mode42.com