Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
38 lines (26 loc) · 1.21 KB

CONTRIBUTING.md

File metadata and controls

38 lines (26 loc) · 1.21 KB

Contributing to unic

Thanks for your interest in contributing.

Before You Start

  • Search existing issues before opening a new one.
  • For larger changes, open an issue first to discuss scope.

Development Workflow

  1. Fork or branch from main.
  2. Create a focused branch following docs/branch-naming-harness.md.
  3. Keep commits small and descriptive.
  4. Run go test ./... before pushing.
  5. Run the documentation harness in docs/documentation-harness.md for user-visible or architecture-relevant changes.
  6. Open a Pull Request with context and testing notes.

Pull Request Checklist

  • The change is scoped and documented.
  • Branch name follows docs/branch-naming-harness.md.
  • README.md and relevant docs/ pages were reviewed and updated if needed.
  • Existing behavior is not broken.
  • Tests or validation steps are included.
  • Related issue is linked (if any).

Commit Message Style

Use clear commit messages. Conventional Commits are recommended:

  • feat: add ...
  • fix: resolve ...
  • docs: update ...

Code of Conduct

By participating, you agree to follow the Code of Conduct.