Skip to content

docs(flaky-tests): Linear field defaults, Link Ticket modal, settings form#665

Draft
samgutentag wants to merge 1 commit into
mainfrom
sam-gutentag/linear-ticketing-field-defaults-link-ticket
Draft

docs(flaky-tests): Linear field defaults, Link Ticket modal, settings form#665
samgutentag wants to merge 1 commit into
mainfrom
sam-gutentag/linear-ticketing-field-defaults-link-ticket

Conversation

@samgutentag
Copy link
Copy Markdown
Member

Summary

  • Documents new Linear ticketing field defaults (Priority, Labels, Estimate, Project, Assignee) scoped per team
  • Documents the new Link Ticket UI modal on the test case details page (previously API-only)
  • Updates settings section to reflect consolidated Configuration form

Source

Test plan

  • Preview in GitBook

Generated by Claude Code

…and Link Ticket modal

Reflects trunk2 PR #3968: field defaults (Priority, Labels, Estimate,
Project, Assignee) scoped per team, Link Ticket UI button on test details
page, and updated settings form structure.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@trunk-staging-io
Copy link
Copy Markdown

Merging to main in this repository is managed by Trunk.

  • To merge this pull request, check the box to the left or comment /trunk merge below.

After your PR is submitted to the merge queue, this comment will be automatically updated with its status. If the PR fails, failure details will also be posted here

@claude
Copy link
Copy Markdown
Contributor

claude Bot commented May 16, 2026

Claude finished @samgutentag's task in 1m 27s —— View job


Review

The changes are clear, well-structured, and improve the page significantly — promoting "Link an existing ticket" to a sibling h3 of "Create a new ticket" mirrors the user mental model better, and the Field defaults section is well-organized. A few small issues below.

Tasks

  • Read PR diff and changed file
  • Compare against sibling docs (Jira integration) for consistency
  • Check grammar, typos, and formatting
  • Post review feedback

Findings

1. linear-integration.md:67 — Grammatically incomplete sentence (nit, preexisting)

You can use [Flaky Tests webhooks](../../webhooks/linear-integration.md) to automate ticket creation, or if you need more control over how tickets are created in Linear. The ticketing integration is not required when using webhooks.

The "or if you need more control..." clause has no verb — it's a sentence fragment grafted onto the first clause. This wording was present before the PR (inside a Note: prefix), but now that it's been promoted to body prose the awkwardness is more visible. Suggest:

You can use [Flaky Tests webhooks](../../webhooks/linear-integration.md) to automate ticket creation or for more control over how tickets are created in Linear. The ticketing integration is not required when using webhooks.

Fix this →

2. linear-integration.md:41 — Priority enumeration is incomplete (nit)

| **Priority** | Default priority (Urgent, High, Medium, Low) |

Linear actually exposes five priority levels including "No priority" as the default. If the form lets users select it, consider listing it for accuracy; otherwise this is fine.

3. linear-integration.md:43 — Estimate type names should be capitalized (style nit)

| **Estimate** | Story point estimate, using the team's configured estimate type (fibonacci, t-shirt, etc.) |

Linear's estimate type labels in-product are capitalized (Exponential, Fibonacci, Linear, T-Shirt). Suggest matching that styling:

| **Estimate** | Story point estimate, using the team's configured estimate type (Fibonacci, T-Shirt, etc.) |

4. Table style consistency (informational, not blocking)

The new Field defaults table at lines 39–45 uses markdown table syntax. The neighboring jira-integration.md uses GitBook <table> syntax for its connection form and markdown for the custom-fields table — so this is consistent with at least one existing pattern in the sibling doc. Leave as-is.

5. Out-of-scope observation

The promotion of "Link existing tickets" from h4 to h3 (now "Link an existing ticket") is a nice structural improvement. The Jira integration page still has it nested as h4 under "Create a new ticket" with only the API-link sentence — worth a follow-up to bring it to parity if/when the Jira Link Ticket UI lands.


Verdict

No blocking issues. The nits above are style/grammar polish. The page is ready to preview in GitBook to verify the new anchor (#link-an-existing-ticket) and the table renders.
Branch

Copy link
Copy Markdown

@github-actions github-actions Bot left a comment

Choose a reason for hiding this comment

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

Auto-approved: Claude code review passed.

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

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants