CONTRIBUTING.md

Contributing

This project uses a fixed local develop branch for day-to-day work. For the full macOS development, clean-room RD loop, and governance workflow, see docs/planes/governance/current/development-workflow.zh.md.

Remotes

Remote	Repository	Role
deepseedx	DeepSeedx/knowledge-pipeline	Primary organization remote.
origin	ylouis8/knowledge-pipeline	Synced personal mirror.

Treat deepseedx as the primary GitHub target for any request that says "GitHub", "release", or "merge to main".

Branch And Sync Convention

Always push develop to both remotes first; only then merge into main.

git remote -v
git push origin develop
git push deepseedx develop

# Merge into main only when explicitly requested.
git switch main
git merge --no-ff develop
git push origin main
git push deepseedx main

Verifying Both Remotes Are Aligned

For release or milestone requests, confirm both remotes match and that develop is an ancestor of main:

git fetch origin develop main
git fetch deepseedx develop main
git merge-base --is-ancestor deepseedx/develop deepseedx/main

House Rules

• Keep new source files focused and normally below 800 lines; existing reviewed line-budget baselines are governed by their maintainability gate rather than silent waivers.
• Reuse, extend, or wrap existing code before adding new methods, classes, or services.
• Do not weaken clean-room, PIT, baseline, lifecycle, or promotion governance gates to make tests pass.
• Run backend default verification from backend/; explicitly add affected tests/scripts/ because the default backend scope does not cover every runner test.
• Do not commit .vscode/, local cache, generated screenshots, temporary scripts, or unrelated output artifacts.
• Never commit .ua/ or abandoned experiment artifacts. Run uv run python scripts/check_docs.py and uv run python scripts/check_skills.py when documentation or workflow links change.