Navigation

  • index
  • next |
  • Synarius Guidelines documentation »
  • Synarius Guidelines

Synarius Guidelines¶

Synarius project title image

This site holds repo-wide programming and contribution guidelines for Synarius. Product-specific installation and feature documentation live in each repository’s own README and Sphinx docs.

  • Programming guidelines
    • Python version
    • Repositories and boundaries
    • General Principle
    • Code style
    • Complexity and Nesting
    • Loops
    • Extraction Criteria
    • Method Length
    • Method Structure (Orchestration Pattern)
    • Typing and tooling
    • Testing
    • Code Coverage
    • Linking documentation to code
    • AI assistant configuration
    • Pull requests
    • Repository-specific notes
  • Tips and Tricks
    • Free Local AI in VS Code with Ollama and Cline

Next topic

Programming guidelines

This Page

  • Show Source

Quick search

Navigation

  • index
  • next |
  • Synarius Guidelines documentation »
  • Synarius Guidelines
© Copyright . Created using Sphinx 9.0.4.