Skip to content

Commit bda412c

Browse files
committed
Add contributing guide
1 parent 638cbfc commit bda412c

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

CONTRIBUTING.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Contributing
2+
3+
Thanks for helping make `nytgames-cli` better.
4+
5+
## Getting Started
6+
7+
- Install Zig `0.15.1`.
8+
- Build: `zig build`
9+
- Run: `zig build run`
10+
- Tests: `zig build test`
11+
12+
## Conventions
13+
14+
- Keep changes focused and small; avoid unrelated refactors in the same PR.
15+
- Format Zig code with `zig fmt` on files you touch.
16+
- Prefer clear, explicit control flow over cleverness.
17+
- Keep the app cross-platform; guard OS-specific code with `builtin.os.tag`.
18+
- Avoid adding new dependencies unless there is a strong reason.
19+
20+
## Documentation
21+
22+
- Update `README.md` for user-facing changes.
23+
- If you change install behavior, update the installer scripts and docs together.
24+
25+
## Commits & PRs
26+
27+
- Use short, imperative commit messages (e.g. "Fix stats date parsing").
28+
- Include a concise summary of the change and how it was tested.
29+
- If tests are not run, say why.
30+
31+
## Release Notes (Maintainers)
32+
33+
- Releases are built by GitHub Actions when a tag `vX.Y.Z` is pushed.
34+
- Packaging and installers are in `.github/workflows/release.yml` and `scripts/`.

0 commit comments

Comments
 (0)