Skip to content

docs: add collaboration process and improve project context#3

Merged
allaspectsdev merged 1 commit intomainfrom
docs/collaboration-process
Mar 30, 2026
Merged

docs: add collaboration process and improve project context#3
allaspectsdev merged 1 commit intomainfrom
docs/collaboration-process

Conversation

@dariuskerpro
Copy link
Copy Markdown
Collaborator

Summary

Closes no specific issue — this establishes the collaboration workflow for both developers.

Approach

Took the process questions that naturally come up when two Claude Code users share a repo and turned them into concrete, lightweight conventions. Expanded CLAUDE.md to be a real shared context doc rather than a skeleton.

Changes

  • CONTRIBUTING.md (new) — Full collaboration workflow:

    • How to claim work (Issues → self-assign → branch → PR)
    • PR sizing (under 300 lines of non-test code)
    • Review process (human review required, 24h turnaround, approve = merge)
    • Keeping CLAUDE.md current (update in same PR, not follow-up)
    • Handling disagreements (first PR wins, discuss before competing PRs)
    • Where discussions happen (Issues for action, Discussions for architecture)
  • CLAUDE.md (expanded) — Added:

    • Architecture Decisions table (ADR-lite)
    • Module Ownership table
    • Error Handling policy
    • Dependency policy (discuss before adding runtime deps)
    • Explicit developer GitHub handles
  • PR template (updated) — Added Approach section and CLAUDE.md checklist

  • README — Contributing section now references CONTRIBUTING.md

CLAUDE.md

  • Updated CLAUDE.md (architecture decisions, module ownership, conventions)

Notes for Reviewer

This is purely documentation — no code changes. It's meant to start a conversation about process, not dictate it. Push back on anything that doesn't work for you.

- Add CONTRIBUTING.md with full collaboration workflow (claiming work,
  PR sizing, review process, disagreement resolution, discussion venues)
- Expand CLAUDE.md with architecture decisions, module ownership,
  error handling policy, and dependency guidelines
- Update PR template with approach section and CLAUDE.md checklist
- Update README contributing section to reference CONTRIBUTING.md
@allaspectsdev allaspectsdev merged commit 4b5c937 into main Mar 30, 2026
1 check passed
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.

2 participants