Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
29 lines (20 loc) · 913 Bytes

CONTRIBUTING.md

File metadata and controls

29 lines (20 loc) · 913 Bytes

Contributing

Thanks for contributing to brandkit.md.

Contribution types

  • Improve specification clarity
  • Expand or refine examples
  • Resolve contradictions between spec and examples
  • Improve parser/validator readiness

Working process

  1. Open an issue or discussion with a clear problem statement.
  2. Prefer small, focused pull requests.
  3. Always justify changes with references to SPEC.md.
  4. Update CHANGELOG.md when behavior or normative rules change.

Rules for specification changes

  • New normative statements must use MUST, SHOULD, or MAY.
  • Breaking changes must be clearly marked and justified.
  • Examples in EXAMPLES/ must be updated when required fields change.

Definition of Done

  • Documentation is consistent (README.md, SPEC.md, docs/).
  • At least one example demonstrates the changed rule.
  • CHANGELOG.md includes an entry for visible behavior changes.