From 66035c54a23c6a7e83cf4dfb84fd87bdc9b595a7 Mon Sep 17 00:00:00 2001 From: Kevin Rajan <7121943+kvnloo@users.noreply.github.com> Date: Tue, 1 Sep 2026 15:30:17 +0000 Subject: [PATCH] Add CONTRIBUTING.md and a README pointer. Document the MIT, no-CLA PR path and how to run node:test module pins. --- CONTRIBUTING.md | 21 +++++++++++++++++++++ README.md | 4 ++++ 2 files changed, 25 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..68ecd7c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,21 @@ +# Contributing + +GameBlocks is released under the MIT License. There is no CLA. By opening a pull request you agree to license your contribution under MIT. + +## Scope + +This repository is source material for coding agents: small, inspectable 3D gameplay modules. Prefer adapting an existing module over adding a new abstraction. Keep a change local to the files that need it. + +## Pull requests + +1. Fork the repository and branch from `main`. +2. Match the surrounding module style (plain ES modules, no bundler). +3. If you change behavior, add a `*.test.js` next to the module and run: + +```bash +node --experimental-default-type=module --test path/to/Module.test.js +``` + +4. Open a pull request against `xt4d/GameBlocks` `main`. + +Issues are currently disabled on the upstream repository, so small, self-contained PRs are the expected contribution path. diff --git a/README.md b/README.md index 352af54..2916fda 100644 --- a/README.md +++ b/README.md @@ -79,6 +79,10 @@ mkdir -p ~/.claude/skills/gameblocks && cp -R gameblocks/. ~/.claude/skills/game https://github.com/user-attachments/assets/98d22d80-06b6-49ac-8b33-2215ccb42222 +## 🤝 Contributing + +See [CONTRIBUTING.md](CONTRIBUTING.md) for the MIT contribution path and how to run module tests. + ## 📜 License GameBlocks is released under the [MIT License](LICENSE).