Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
51 lines (39 loc) · 1.02 KB

CONTRIBUTING.md

File metadata and controls

51 lines (39 loc) · 1.02 KB
Raw

Contributing to Synix

Thanks for your interest in contributing.

Development Setup

  1. Clone the repo.
  2. Install dependencies: 
    uv sync
  3. Run tests: 
    uv run pytest

Development Workflow

  1. Create a feature branch.
  2. Make focused changes.
  3. Add or update tests.
  4. Before every commit, run the full test suite and demo smoke checks: 
    uv run pytest tests/ -v
uv run synix demo run templates/01-chatbot-export-synthesis
uv run synix demo run templates/05-batch-build
  5. Run the full release checks before opening a PR: 
    uv run release

Pull Request Guidelines

  • Keep PRs small and scoped.
  • Include a clear description of what changed and why.
  • Include test updates for behavior changes.
  • Link related issues when applicable.

Reporting Bugs

Please open an issue with:

  • expected behavior
  • actual behavior
  • reproduction steps
  • environment details

Questions

If you are unsure about an approach, open an issue first to discuss.