Skip to content

Contributing

This project welcomes contributions of all kinds: code, tests, documentation, design feedback, and ideas.

The canonical contribution guidelines live in the repository root CONTRIBUTING.md. This page summarizes the key points:

Contribution Workflow

  1. Fork and create a feature branch: feat/<short-name> or fix/<short-name>
  2. Keep commits small and meaningful
  3. Add or update tests when changing behavior
  4. Open a Pull Request describing problem, approach, and trade‑offs

Commit Message Format (Suggested)

<type>(optional scope): <short summary> where type is one of: feat, fix, docs, chore, refactor, test, perf, build.

Areas to Help

  • Filling out missing diagrams or mockups
  • Schema refinement & validation tests
  • Performance and caching instrumentation
  • Improving accessibility notes in mockups

Reporting Bugs

Provide: description, steps to reproduce, expected vs actual, environment details.

Security

Please avoid posting potential security issues publicly until a private disclosure process is defined.

License

By contributing, you agree your contributions are licensed under the repository license (MIT).

For full details see the root CONTRIBUTING.md file.