Operational Conventions

This page defines working conventions for contributors.

Branching

• Use main for stable releases.
• Use develop for ongoing integration.
• Use short-lived feature branches from develop.

Suggested branch naming:

• feat/<topic>
• fix/<topic>
• docs/<topic>

Pull Requests

Before opening a PR:

1. Run pipeline:
   • bash scripts/runtime/pkm_python.sh scripts/automation/run_all.py
2. Confirm no unintended diffs.
3. Update relevant docs if schema or workflow changed.

PR description should include:

• what changed
• why it changed
• how it was validated

Commit Message Pattern

Suggested commit styles:

• feat: add index generation for mentors and mentees
• fix: enforce generated marker validation
• docs: add publishing safety checklist
• chore: update hook and ci runtime launcher

For generated-only updates, prefer explicit messages:

• chore(generated): regenerate notes and indexes

Pre-Commit Hook

Install versioned hooks:

bash scripts/setup/install_hooks.sh

This enables .githooks/pre-commit, which runs the full automation pipeline.