Skip to content

Doc: fork steps + release labels in CONTRIBUTING #47

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

Merged
heyitsStylez merged 1 commit into from
May 7, 2026
Merged

Doc: fork steps + release labels in CONTRIBUTING #47

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
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,14 @@ merged.

## Pull requests

1. **Fork** this repo and clone your fork.
2. **Branch** off `main` (`git checkout -b my-change`).
3. Make your edits under `src/`, run the build and tests (see above).
4. **Push** your branch to your fork and open a PR against
`heyitsStylez/hyperwheel:main`.

Then:

- Keep changes focused — one feature or fix per PR.
- Match the existing style; this codebase deliberately avoids bundlers,
frameworks, and dependencies beyond Chart.js (CDN).
Expand All @@ -50,6 +58,15 @@ Tests live under `test/`:

CI runs `npm test` on every push and PR via `.github/workflows/test.yml`.

## Release labels (maintainers)

PRs can carry one of these labels to control the auto-release version bump:

- `release:major` — major bump (X.0.0)
- `release:minor` — minor bump (x.Y.0)
- `release:skip` — no tag, no release (use for doc-only or infra-only changes)
- (no label) — patch bump (x.y.Z)

Modules that need to be `require()`-able from Node (e.g. `04b-lot-engine.js`)
use a guarded dual-export footer:

Expand Down
Loading