Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
63 lines (44 loc) · 1.44 KB

CONTRIBUTING.md

File metadata and controls

63 lines (44 loc) · 1.44 KB
Raw

Contributing to Ack

Thanks for helping improve Ack. Keep changes focused, tested, and easy to review. By participating, you agree to follow the Code of Conduct.

Development setup

dart pub get
dart run melos bootstrap

Ack uses a Melos workspace. Run commands from the repository root unless a package README says otherwise.

Before opening a PR

  1. Keep the change scoped to one problem.
  2. Add or update tests for behavior changes.
  3. Update docs or README snippets when public APIs, examples, or setup steps change.
  4. Run the relevant checks:
dart run melos run analyze
dart run melos run test

For code generation changes, also run:

dart run melos run test:gen

For JSON Schema export changes, also run:

dart run melos run validate-jsonschema

Commit style

Use Conventional Commits, for example:

feat(ack): add schema helper
fix(generator): preserve nullable list getters
docs: clarify codec examples

Use ! or a BREAKING CHANGE: footer for breaking API changes.

Release notes

User-facing changes should update the relevant package CHANGELOG.md. Release publishing is handled by maintainers through PUBLISHING.md.

Getting help and reporting security issues

Use SUPPORT.md for questions and public bug reports. Follow SECURITY.md for vulnerabilities; do not disclose suspected security issues in a public issue.