Skip to content

docs: add CONTRIBUTING.md with team conventions#35

Open
MichelleGel wants to merge 2 commits into
mainfrom
docs/05-contributing-guide
Open

docs: add CONTRIBUTING.md with team conventions#35
MichelleGel wants to merge 2 commits into
mainfrom
docs/05-contributing-guide

Conversation

@MichelleGel

Copy link
Copy Markdown
Contributor

Closes

Closes #5

Summary

Adds CONTRIBUTING.md documenting the team's working conventions, consolidated from the project plan:

  • Branching model (GitHub Flow) and branch naming format
  • Commit message format (Conventional Commits)
  • Pull request rules: 300-line limit, required approvals, resolved conversations, green CI
  • Work-in-progress limit (1 issue per person)
  • The 30-minute blocked rule
  • Definition of Done checklist
  • Naming conventions for provider agnosticism (env vars, function names)
  • Labels reference (area, type, status, contract)
  • Pair programming points (conditional edge, SSE connection)
  • Traces as the primary debugging tool

This is a documentation-only change, no code affected.

How to test

  1. Read through CONTRIBUTING.md and confirm it accurately reflects how the team has been working since A-01.
  2. Each of the 4 team members should review and approve this PR — this is required per the issue's acceptance criteria, not just one reviewer.

Dashboard screenshot

N/A — documentation only.

Checklist

  • Traces emitted correctly (start/end) if agents were touched — N/A
  • No provider SDK imported outside the gateway client — N/A
  • docker compose up still works — not affected
  • README updated if setup/config changed — N/A, this is a new standalone doc

@MichelleGel MichelleGel self-assigned this Jul 17, 2026
@MichelleGel MichelleGel added infra Infra area docs Documentation labels Jul 17, 2026

@Andres-Torrez Andres-Torrez left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good job

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation infra Infra area

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Infra] Write CONTRIBUTING.md with team conventions

2 participants