Skip to content

docs: document microsite scope convention #97

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
cdtinney wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: document microsite scope convention #97

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
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,17 @@ Format: `type(scope): description`

Common types: `feat`, `fix`, `refactor`, `docs`, `chore`, `test`, `style`

**Microsite scope:** Changes to a microsite must include the microsite name as the scope. The scope matches the directory name under `src/microsites/`, `src/pages/`, and `public/` (currently `hands` and `whatarewedoinghere`). Commits that mix microsite and main-site changes should be split.

Examples:

- `feat: add underwater theme`
- `fix: clear stale CSS variables on theme switch`
- `refactor: extract math helpers from animation.ts`
- `docs: update CONTRIBUTING.md`
- `test: add e2e tests for theme switching`
- `feat(hands): add new hands background`
- `fix(whatarewedoinghere): correct sitemap URL`

## Architecture

Expand Down
Loading