Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
47 lines (33 loc) · 1.32 KB

CONTRIBUTING.md

File metadata and controls

47 lines (33 loc) · 1.32 KB
Raw

Contributing

Thanks for improving Aura. The best contributions are focused, easy to review, and visible in the product.

Before You Start

  • Search existing issues before opening a new one.
  • For UI changes, include before/after screenshots or a short screen recording.
  • Keep pull requests small. Separate docs, refactors, and feature work when practical.
  • Use clear titles: fix:, feat:, docs:, refactor:, test:, or chore:.

Local Development

bun install
bun run dev

Before opening a pull request:

bun run lint
bun run build

Project Standards

  • Keep the app static-host friendly.
  • Do not add API keys, tracking scripts, or backend services without an issue and maintainer agreement.
  • Prefer existing components and patterns before introducing new abstractions.
  • Keep copy direct. Avoid placeholder marketing language.
  • Respect accessibility basics: semantic HTML, visible focus states, keyboard paths, contrast, and reduced-motion support.

Good First Issues

Good first contributions usually live in these areas:

  • README screenshot updates.
  • Broken link cleanup.
  • Reduced-motion support.
  • Keyboard and focus improvements.
  • Small performance wins.
  • Documentation clarifications.

Code of Conduct

Participation in this project is covered by CODE_OF_CONDUCT.md.