-
Notifications
You must be signed in to change notification settings - Fork 2.5k
docs(skills): fix claims-vs-reality drift from the skills audit (TML-3223) #30088
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
Open
tensordreams
wants to merge
4
commits into
main
Choose a base branch
from
tml-3223-skill-audit-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
9f7860d
docs(skills): fix claims-vs-reality drift from the skills audit
tensordreams 6f9eae3
docs(skills): apply review fixes to the skills-audit doc corrections …
tensordreams f746c15
docs(skills): resolve the walkthrough base and page the pending-revie…
tensordreams 3d943a5
docs(skills): reuse Step 1's resolved base ref for the walkthrough (T…
tensordreams 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
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
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
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 | ||||
|---|---|---|---|---|---|---|
| @@ -1,11 +1,11 @@ | ||||||
| --- | ||||||
| name: contrib-pr | ||||||
| description: Open a high-quality external contributor PR against prisma-next. Use when the user is an outside contributor (not a Prisma maintainer) and wants to submit a change as a pull request from a fork. Encodes the contribution flow from CONTRIBUTING.md so the resulting PR passes review on the first round. | ||||||
| description: Open a high-quality external contributor PR against prisma/prisma. Use when the user is an outside contributor (not a Prisma maintainer) and wants to submit a change as a pull request from a fork. Encodes the contribution flow from CONTRIBUTING.md so the resulting PR passes review on the first round. | ||||||
| --- | ||||||
|
|
||||||
| # Contributor PR skill (external) | ||||||
|
|
||||||
| This skill is for **external contributors** to `prisma/prisma` who are using an LLM-based agent to author or finalize a PR. It is intentionally separate from the maintainer-facing `create-pr` skill: it does not depend on Linear access, internal plan/spec documents, or any private context. It encodes the expectations laid out in [`CONTRIBUTING.md`](../../../CONTRIBUTING.md) as a runnable workflow, so the PR you produce matches the shape maintainers expect on the first review round. | ||||||
| This skill is for **external contributors** to `prisma/prisma` who are using an LLM-based agent to author or finalize a PR. It is intentionally separate from the maintainer-facing `create-pr` skill: it does not depend on Linear access, internal plan/spec documents, or any private context. It encodes the expectations laid out in [`CONTRIBUTING.md`](../../CONTRIBUTING.md) as a runnable workflow, so the PR you produce matches the shape maintainers expect on the first review round. | ||||||
|
|
||||||
| If the user is a maintainer with access to internal Linear tickets, use `create-pr` instead. | ||||||
|
|
||||||
|
|
@@ -14,8 +14,8 @@ If the user is a maintainer with access to internal Linear tickets, use `create- | |||||
| Trigger this skill when the user says any of: | ||||||
|
|
||||||
| - "Open a PR for this contribution" | ||||||
| - "Submit this as a PR to prisma-next" | ||||||
| - "I'm contributing to prisma-next, finalize my change" | ||||||
| - "Submit this as a PR to prisma/prisma" | ||||||
| - "I'm contributing to Prisma Next, finalize my change" | ||||||
| - "Help me get this PR ready for review" | ||||||
|
|
||||||
| If the user has clearly already followed the contribution flow and just needs the `gh pr create` invocation, you may skip directly to step 5. | ||||||
|
|
@@ -38,9 +38,9 @@ This skill is a pit of success — there is no CI gate that checks you used it. | |||||
|
|
||||||
| Before doing anything else, read the project's contribution docs: | ||||||
|
|
||||||
| 1. Read [`CONTRIBUTING.md`](../../../CONTRIBUTING.md). This is the source of truth for setup, the test command set, DCO signoff, and PR expectations. | ||||||
| 2. Read [`CODE_OF_CONDUCT.md`](../../../CODE_OF_CONDUCT.md) so you understand what's expected in your interactions on the PR thread. | ||||||
| 3. Skim [`SECURITY.md`](../../../SECURITY.md). If your change is fixing a security issue, **stop and use the Private Vulnerability Reporting flow instead** — do not open a public PR. | ||||||
| 1. Read [`CONTRIBUTING.md`](../../CONTRIBUTING.md). This is the source of truth for setup, the test command set, DCO signoff, and PR expectations. | ||||||
| 2. Read [`CODE_OF_CONDUCT.md`](../../CODE_OF_CONDUCT.md) so you understand what's expected in your interactions on the PR thread. | ||||||
| 3. Skim [`SECURITY.md`](../../SECURITY.md). If your change is fixing a security issue, **stop and use the Private Vulnerability Reporting flow instead** — do not open a public PR. | ||||||
|
|
||||||
| If anything in `CONTRIBUTING.md` contradicts what this skill says, `CONTRIBUTING.md` wins. | ||||||
|
|
||||||
|
|
@@ -51,7 +51,7 @@ Before opening the PR, check: | |||||
| - **One logical change.** If the diff includes unrelated cleanup or "while I was here" fixes, ask the user whether to split them into separate PRs. Mixed-scope PRs almost always trigger a "please split this" review comment. | ||||||
| - **Substantive change?** If the change is more than a typo / doc fix / obvious bug fix, ask the user whether they opened a tracking issue first per `CONTRIBUTING.md`. If not, recommend they do — maintainers will respond within 5 business days, and a half-day issue conversation can prevent a one-week PR rewrite when the design direction differs from what they expect. | ||||||
| - **Tests updated.** If the change has any behavioural delta and there are no test changes in the diff, push back on the user before opening the PR. "Why aren't there tests?" is the most common reason a PR gets bounced. | ||||||
| - **No backward-compat shims.** prisma-next is pre-1.0; if the change renames or removes an API, the call sites should be updated, not aliased. | ||||||
| - **No backward-compat shims.** Prisma Next is pre-1.0; if the change renames or removes an API, the call sites should be updated, not aliased. | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| ### Step 3 — Run the right test suites | ||||||
|
|
||||||
|
|
@@ -114,15 +114,16 @@ Examples: | |||||
| - `fix(postgres-adapter): handle null in jsonb columns` | ||||||
| - `docs(contributing): clarify pnpm install steps` | ||||||
|
|
||||||
| The PR title flows directly into the auto-generated GitHub Release notes when the version that contains it is published — pick a title a downstream user would understand. | ||||||
| PR titles are the raw material the release-notes author triages when a version ships, so pick a title a downstream user would understand. | ||||||
|
|
||||||
| #### Body | ||||||
|
|
||||||
| Fill in the [pull request template](../../../.github/PULL_REQUEST_TEMPLATE.md) sections in order: | ||||||
| Fill in the [pull request template](../../.github/PULL_REQUEST_TEMPLATE.md) sections in order: | ||||||
|
|
||||||
| - **Linked issue**: `Fixes #N` / `Refs #N`. If no issue exists because the change is small, write `n/a — small change`. | ||||||
| - **Summary**: one or two sentences focused on *why*, not file-by-file *what*. "Adds X because Y was broken" rather than "Adds X function in foo.ts and modifies bar.ts". | ||||||
| - **Testing performed**: list the actual `pnpm test:*` commands you ran. If you ran a manual repro (e.g. against the demo), say so. | ||||||
| - **Skill update**: say which agent skill the change teaches. Write `n/a — internal only` only when the change is purely internal or a refactor with no user-visible delta. A user-facing change that teaches no existing skill still needs a sentence saying why no skill update is required. The checklist below asks you to confirm this section. | ||||||
| - **Checklist**: confirm DCO signoff, scope, tests, conventional title. | ||||||
| - **Notes for the reviewer** (optional): alternative approaches you considered, follow-ups intentionally deferred, anything you want the reviewer to focus on. | ||||||
|
|
||||||
|
|
||||||
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
Oops, something went wrong.
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.