Skip to content

pull-request-flow.md

Latest commit

 

History

History
35 lines (26 loc) · 1.3 KB

pull-request-flow.md

File metadata and controls

35 lines (26 loc) · 1.3 KB
Raw
title Pull Request Flow
description Issue-first workflow, branch naming, and PR conventions
audience developer

Wiki Home › Contributing

Pull Request Flow

The project is issue-first: discuss before you build.

flowchart LR
    A["Open / find an issue"] --> B["Assign yourself,<br/>label it 'Doing'"]
    B --> C["Branch:<br/>&lt;issue#&gt;-short-title"]
    C --> D["Make the change"]
    D --> E["PR to main:<br/>'#&lt;issue#&gt; Issue Title'"]
    E --> F["Review & merge"]
Loading

Conventions

  • Branch name: issue number + title, e.g. 12-add-tea-endpoint
  • PR title: issue number + issue title, e.g. #12 Add Tea Endpoint
  • PR body: first line links the issue; then a brief summary addressing the issue's acceptance criteria
  • Data PRs should include the endpoint documentation described in CONTRIBUTING.md (overview, example request/response, operations)
  • Keeping the branch conflict-free and non-breaking is the contributor's responsibility

The Code of Conduct applies everywhere. For what reviewers look at in data contributions, see Adding an Endpoint.

Related