Contributing

August 24, 2026 · View on GitHub

Thank you for improving this unofficial community project. By participating, you agree to the Code of Conduct.

Before opening a pull request

  1. Search existing issues and discussions.
  2. For behavior or registry-contract changes, open an issue before implementation.
  3. For a new theme, follow Creating a theme and use original or properly licensed artwork.
  4. Keep the patch focused. Do not commit profile files, credentials, generated archives, or node_modules.

Development

corepack enable
pnpm install --frozen-lockfile
pnpm bundle
pnpm test
npm pack --dry-run --json

Pull requests must keep the build deterministic and package only the files declared in package.json. Update tests and CHANGELOG.md for user-visible changes.

Design and accessibility

  • Use the registry instead of adding theme-name branches.
  • Preserve DeepSeek original as a zero-override option.
  • Define all 16 light/dark semantic tokens and meet the validator’s contrast thresholds.
  • Scope artwork to the hero phase and keep controls readable at narrow widths.
  • Avoid copyrighted characters, logos, or confusingly similar official branding.

Commit messages

Use a concise imperative summary, for example Add aurora ink theme. By submitting a contribution, you license it under this repository’s MIT License and confirm you have the right to provide all included code and assets.