-
Notifications
You must be signed in to change notification settings - Fork 4
Add WORKFLOW.md, issue templates, and PR template (#7) #48
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| name: Bug report | ||
| description: Report something that isn't working as expected | ||
| title: "[Bug]: " | ||
| type: Bug | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thanks for taking the time to report a bug! Please fill out the details below | ||
| so we can reproduce and fix the issue. | ||
|
|
||
| - type: textarea | ||
| id: description | ||
| attributes: | ||
| label: What happened? | ||
| description: A clear and concise description of the bug. | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: expected | ||
| attributes: | ||
| label: What did you expect to happen? | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: repro | ||
| attributes: | ||
| label: Steps to reproduce | ||
| description: List the steps needed to reproduce the behavior. | ||
| placeholder: | | ||
| 1. Run `uv run -m tapio.cli ...` | ||
| 2. ... | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: environment | ||
| attributes: | ||
| label: Environment | ||
| description: OS, Python version, and whether you're using the dev container, Codespaces, or a manual setup. | ||
| validations: | ||
| required: false | ||
|
|
||
| - type: textarea | ||
| id: logs | ||
| attributes: | ||
| label: Relevant logs or output | ||
| description: Paste any relevant error output. This will be rendered as code automatically. | ||
| render: shell | ||
| validations: | ||
| required: false |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| name: Feature request | ||
| description: Suggest a new capability or enhancement | ||
| title: "[Feature]: " | ||
| type: Feature | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thanks for suggesting an improvement! Please describe the feature and the | ||
| problem it solves. | ||
|
|
||
| - type: textarea | ||
| id: problem | ||
| attributes: | ||
| label: What problem does this solve? | ||
| description: Describe the use case or limitation that motivates this request. | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: proposal | ||
| attributes: | ||
| label: Proposed solution | ||
| description: Describe what you'd like to see, as concretely as you can. | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: alternatives | ||
| attributes: | ||
| label: Alternatives considered | ||
| description: Any other approaches you considered, and why this one is preferred. | ||
| validations: | ||
| required: false | ||
|
|
||
| - type: dropdown | ||
| id: area | ||
| attributes: | ||
| label: Area | ||
| description: Which part of the system does this mostly affect? (You can also add area labels after the issue is created.) | ||
| options: | ||
| - agents | ||
| - auth | ||
| - dx | ||
| - ops | ||
| - partners | ||
| - platform | ||
| - rag | ||
| - safety | ||
| - security | ||
| - ux | ||
| - Not sure | ||
| validations: | ||
| required: false |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| name: Task / research spike | ||
| description: Exploratory work, maintenance, or a task that doesn't fit a bug or feature | ||
| title: "[Task]: " | ||
| type: Task | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Use this for maintenance work, exploratory research, or anything that isn't | ||
| squarely a bug fix or a new user-facing feature. | ||
|
|
||
| - type: textarea | ||
| id: goal | ||
| attributes: | ||
| label: Goal | ||
| description: What are we trying to learn, build, or clean up? | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: checklist | ||
| attributes: | ||
| label: Checklist | ||
| description: Break the work into concrete, checkable steps if you can. | ||
| placeholder: | | ||
| - [ ] ... | ||
| - [ ] ... | ||
| validations: | ||
| required: false | ||
|
|
||
| - type: textarea | ||
| id: context | ||
| attributes: | ||
| label: Context / references | ||
| description: Links to related issues, discussions, or external resources. | ||
| validations: | ||
| required: false |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| ## Description | ||
|
|
||
| <!-- What does this PR do, and why? Link the issue it addresses, e.g. "Closes #7". --> | ||
|
|
||
| ## Checklist | ||
|
|
||
| - [ ] I ran `uv run pytest` and all tests pass | ||
| - [ ] I ran `uv run prek run --all-files` (or `uv run ruff check .` and `uv run ruff check . --fix`) and addressed any issues | ||
| - [ ] I ran `uv run mypy tapio` and `uv run pyrefly check` and addressed any issues | ||
| - [ ] New/changed code meets the project's 80% coverage guideline (`uv run pytest --cov=tapio`) | ||
| - [ ] I updated `README.md` if this PR changes user-facing behavior | ||
|
|
||
| ## Related issue | ||
|
|
||
| <!-- e.g. Closes #7 --> | ||
|
|
||
| ## Additional context | ||
|
|
||
| <!-- Anything reviewers should know: design tradeoffs, things you're unsure about, screenshots, etc. --> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| # Project Workflow | ||
|
|
||
| This document explains how we organize and triage work in the Tapio project: the GitHub | ||
| Project board, our label taxonomy, and how issues move from idea to done. | ||
|
|
||
| ## Table of Contents | ||
|
|
||
| - [Project Board](#project-board) | ||
| - [Status](#status) | ||
| - [Priority](#priority) | ||
| - [Iteration](#iteration) | ||
| - [Size](#size) | ||
| - [Issue Types](#issue-types) | ||
| - [Label Taxonomy](#label-taxonomy) | ||
| - [Area Labels](#area-labels) | ||
| - [Triage Labels](#triage-labels) | ||
| - [Triage Process](#triage-process) | ||
|
|
||
| ## Project Board | ||
|
|
||
| All issues live on the [Finntegrate Team project board](https://github.com/orgs/Finntegrate/projects/1). | ||
| The board has several views (Board, Current iteration, Roadmap, My items) over the same | ||
| underlying set of fields: | ||
|
|
||
| ### Status | ||
|
|
||
| - **Todo** — not yet started | ||
| - **In progress** — actively being worked on | ||
| - **Done** — completed (hidden from the default board view, which filters with `-status:Done`) | ||
|
|
||
| ### Priority | ||
|
|
||
| - **High** — should be picked up first; usually foundational or blocking other work | ||
| - **Medium** — important, but not urgent | ||
| - **Low** — nice to have, or exploratory | ||
|
|
||
| Priority reflects project importance, not difficulty. A `good first issue` can still carry | ||
| a `High` priority label. | ||
|
|
||
| ### Iteration | ||
|
|
||
| Some issues are assigned to a numbered iteration (e.g. `Iteration 2`) for sprint-style | ||
| planning. Most issues are not yet assigned to an iteration and simply sit in the backlog | ||
| until prioritized. | ||
|
|
||
| ### Size | ||
|
|
||
| An optional t-shirt-size estimate (e.g. `M`) can be set on an issue once its scope is | ||
| understood. Most issues do not yet have a size set — add one if you have enough context | ||
| to estimate the work, but don't block on it. | ||
|
|
||
| ## Issue Types | ||
|
|
||
| GitHub's built-in issue type field (`Bug`, `Feature`, `Task`) is available and used on some | ||
| issues (for example, #4 is typed `Task`), but adoption across the backlog is inconsistent — | ||
| many issues, including substantial engineering proposals, currently have no type set. If | ||
| you're triaging or filing an issue, setting a type when it's clear-cut (a defect is a `Bug`, | ||
| a net-new capability is a `Feature`, exploratory or maintenance work is a `Task`) is helpful, | ||
| but don't assume an unset type means anything in particular about an existing issue. | ||
|
|
||
| ## Label Taxonomy | ||
|
|
||
| Labels fall into two categories: **area labels**, which describe what part of the system an | ||
| issue touches, and **triage labels**, which describe the issue's status or kind. | ||
|
|
||
| ### Area Labels | ||
|
|
||
| | Label | Description | | ||
| | --- | --- | | ||
| | `agents` | Multi-agent / LangGraph | | ||
| | `auth` | Authentication and authorization | | ||
| | `dx` | Developer experience | | ||
| | `ops` | Observability, monitoring, alerting | | ||
| | `partners` | Partner integrations and visibility | | ||
| | `platform` | Infrastructure, deployment, hosting | | ||
| | `rag` | Retrieval pipeline | | ||
| | `safety` | AI safety, guardrails, response quality | | ||
| | `security` | Security and compliance | | ||
| | `ux` | User experience and interface | | ||
|
|
||
| An issue can carry more than one area label if it spans multiple parts of the system. | ||
|
|
||
| ### Triage Labels | ||
|
|
||
| | Label | Description | | ||
| | --- | --- | | ||
| | `documentation` | Improvements or additions to documentation | | ||
| | `duplicate` | This issue or pull request already exists | | ||
| | `good first issue` | Good for newcomers | | ||
| | `help wanted` | Extra attention is needed | | ||
| | `invalid` | This doesn't seem right | | ||
| | `question` | Further information is requested | | ||
| | `wontfix` | This will not be worked on | | ||
|
|
||
| ## Triage Process | ||
|
|
||
| When a new issue comes in: | ||
|
|
||
| 1. A maintainer adds it to the [project board](https://github.com/orgs/Finntegrate/projects/1), | ||
| which sets its initial **Status** to `Todo`. | ||
| 2. The maintainer applies relevant **area label(s)** and a **Priority**. | ||
| 3. If the issue looks approachable for new contributors, `good first issue` and/or | ||
| `help wanted` are added. | ||
| 4. Contributors can comment on an issue to claim it, then open a pull request that | ||
| references the issue number once work begins, following the | ||
| [Pull Request Process](CONTRIBUTING.md#pull-request-process) in `CONTRIBUTING.md`. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.