Contributing¶

Contribution Principles¶

• prioritize clarity of ownership and intent
• keep PRs narrowly scoped where possible
• include validation evidence, not only claims
• avoid introducing cross-module coupling silently

Pull Request Workflow¶

1. describe problem and affected workflows
2. implement focused change set
3. add/update tests
4. run required checks and suites
5. submit PR with risk and rollout notes

Required Validation Baseline¶

# Django checks
docker compose run --rm app python manage.py check

# Targeted module test example
docker compose run --rm app sh -c "pytest requirements_mgmt/tests -v"

# Integrated validation
./scripts/run_smoke_tests.sh
./scripts/run_tests.sh

PR Content Checklist¶

• objective and rationale
• modules/routes/templates touched
• migration/data implications
• security/operational implications
• exact validation commands executed

Commit Guidance¶

• keep commits logically grouped
• use intent-focused commit messages
• avoid mixing unrelated cleanup into functional PRs

Related Pages¶

• Development Workflow
• Testing Strategy
• Security & Configuration