summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..8a16293
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,30 @@
+# Contributing
+
+Standards: [docs/DEVELOPMENT.md](docs/DEVELOPMENT.md), [docs/DEVELOPMENT.md](docs/DEVELOPMENT.md). Doc index: [docs/README.md](docs/README.md).
+
+```bash
+git clone git@github.com:ngteq/MAX25-Stack.git && cd MAX25-Stack
+./scripts/build.sh
+./scripts/release-check.sh
+```
+
+## Git identity
+
+**Only** this identity — no alternatives:
+
+```
+user.name = ngteq
+user.email = info@un1t.me
+```
+
+Push **only** via SSH `~/.ssh/id_ed25519_ngteq` → `git@github.com:ngteq/MAX25-Stack.git`.
+
+## Pull requests
+
+- Small, focused diffs; plugin hierarchy unchanged unless discussed
+- Plugin / manifest → `plugins/manifest.yaml`, `plugins/**/plugin.yaml`
+- HyBBX attach → [docs/HYBBX.md](docs/HYBBX.md) + `share/hybbx/*.ini.example`
+- Platform → [docs/PLATFORMS.md](docs/PLATFORMS.md)
+- Verify: `./scripts/test.sh && ./scripts/release-check.sh`
+
+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