Skip to content

Add contributor and agent guide (CLAUDE.md)#32

Merged
MHoroszowski merged 1 commit intomasterfrom
chore/contributor-guide
May 6, 2026
Merged

Add contributor and agent guide (CLAUDE.md)#32
MHoroszowski merged 1 commit intomasterfrom
chore/contributor-guide

Conversation

@MHoroszowski
Copy link
Copy Markdown
Owner

Documents project-level rules that apply to every contributor — human or AI — working in this fork:

  • Editable-install gotcha with git worktree (use PYTHONPATH=src or work in the main checkout)
  • Manual port over git cherry-pick for upstream PRs (this fork has a repo-wide ruff format pass that upstream master lacks)
  • Test discipline expectations (pytest + behave + ruff baselines and TDD ordering)
  • Branch / PR workflow with approval-gated UAT step
  • Reporting contract for AI agents — verbatim verification output required, no self-attestation

Claude Code auto-merges project-root CLAUDE.md into any session opened in the repo, so the rules are enforced without any additional setup.

Refs PR #30 as canonical feature example; PR #31 as the run that surfaced most of these rules in practice.

Documents project-level rules that apply to every contributor — human or
AI — working in this fork:

  • Editable-install gotcha with git worktree (use PYTHONPATH=src or work
    in the main checkout)
  • Manual port over git cherry-pick for upstream PRs (this fork has a
    repo-wide ruff format pass that upstream master lacks)
  • Test discipline expectations (pytest + behave + ruff baselines and
    TDD ordering)
  • Branch / PR workflow with approval-gated UAT step
  • Reporting contract for AI agents — verbatim verification output
    required, no self-attestation

Claude Code auto-merges project-root CLAUDE.md into any session opened
in the repo, so the rules are enforced without any additional setup.

Refs PR #30 as canonical feature example, PR #31 as the run that
surfaced most of these rules in practice.
@MHoroszowski MHoroszowski merged commit eacbea6 into master May 6, 2026
6 checks passed
@MHoroszowski MHoroszowski deleted the chore/contributor-guide branch May 6, 2026 21:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant