Contributing & Changelog

Local Development

pnpm install
vpr dev

Before committing, run:

pnpm verify

This single command checks code formatting, TypeScript types, the static build, internal doc links, color contrast, SVG/PNG asset consistency, and accessibility of core pages.

Source File Rules

• Adjusting the logo artwork: modify assets/logo/source, then run pnpm assets:build to regenerate exports.
• Changing colors, spacing, and theme styles: edit apps/docs/.vitepress/theme/custom.css centrally and check both light and dark themes.
• Refining spec entries: when editing page content, append a matching entry to CHANGELOG.md.
• Never edit generated PNG images or the download copies in the site directly.

Change Levels

• Patch: typos, clarification, asset fixes that don't change usage.
• Minor: new templates or backward-compatible spec additions.
• Major: changes to the logo composition or the semantics of existing rules.

Breaking changes must provide a detailed migration guide and keep at least one Minor deprecation window.

Brand Change Review

Logo, brand name, primary color, and authorization boundaries are approved by organization maintainers. Review must include motivation, affected assets, small-size and monochrome previews, light/dark background testing, and accessibility impact.

Content Contributions

Rules should be written as measurable, verifiable behaviors, avoiding adjectives like "modern", "minimal", or "comfortable" that can't be objectively enforced. Example data must never contain real student information, accounts, access tokens, or unauthorized confidential university material.