Skip to content

Development

Purpose

This section is the canonical development guide for work inside this repository. It is for contributors changing code, tests, docs, or release behavior.

flowchart TD
    A[Set up workspace] --> B[Understand the change model]
    B --> C[Make changes in the right layer]
    C --> D[Verify with tests and evidence]
    D --> E[Prepare release or follow-up work]

This flowchart is the contributor path through the section. It starts with local setup, then explains how to place changes correctly, and only then moves into evidence and release-facing expectations.

mindmap
  root((Development))
    Setup
      workspace tools
      repo-managed virtualenv
    Change model
      routing
      policy
      emission
    Evidence
      tests
      maintainer checks
    Release
      compatibility
      rollback

The mindmap groups that path by responsibility area. It is a quick reminder that setup, code placement, evidence, and release review are all part of the same contributor workflow.

Read This Set In Order

  1. Workspace And Tooling
  2. Change Model
  3. Testing And Evidence
  4. Release And Compatibility

Scope

These pages are intentionally narrow:

  • they describe the current contributor workflow
  • they prefer enforceable rules over broad aspiration
  • they point to architecture and contracts only when deeper detail is needed

Collaboration Standard

Contributors are expected to keep project spaces respectful, direct, and safe to participate in.

  • show empathy, kindness, and professional respect
  • give concrete feedback without personal attacks or intimidation
  • do not harass, discriminate, stalk, or publish private information without permission
  • do not retaliate against someone for reporting a concern

These expectations apply in the repository, issues, discussions, chat, and other public project spaces where someone is representing Bijux. Report serious conduct concerns to mousavi.bijan@gmail.com. Maintainers may moderate participation, remove contributions, or limit access when behavior is not compatible with these rules.

Next Step

If you only need to use the CLI, go to User Guide. If you are contributing, start with Workspace And Tooling.