Skip to content

Add CONTRIBUTING.md and a README pointer #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kvnloo wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add CONTRIBUTING.md and a README pointer #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).