prepare-pull-request
Prepares a Gravitee Lab change for review by running the checks that match it and printing the pull request description.
- License 许可
- AGPL-3.0
- 最近更新
- 2026-11-09
- Stars
- ★ 4
- Forks
- 1
01 前言 Front Matter
- name
- prepare-pull-request
- description
- Prepares a Gravitee Lab change for review by running the checks that match it and printing the pull request description.
03 SKILL.md 正文
Prepare a pull request
Run this before a change leaves the machine, in the repository that holds it: the Lab, or a catalog. It checks and prints;
it never pushes or opens a pull request unless the person asks. CONTRIBUTING.md has the workflow, and
.github/PULL_REQUEST_TEMPLATE.md the description.
-
See what changed:
git status --short, thengit diff --statfor the changes not staged yet andgit diff --cached --statfor the ones staged. Group them: an add-on, a setup or a playground (they are in a catalog, not in the Lab); Python (lab-ui/,seeder/); an app of a playground; the Lab UI's page; documentation. -
Run the checks that match, from the table of
CONTRIBUTING.md("Before you open a pull request"), and read the output of each: a skipped test did not pass.make smokeand starting an item need the person's lab: ask before you start or stop anything, and say what you could not run. -
Confirm that nothing private is in the change:
git diff --cached --name-only | grep -E '(^|/)(\.env|\.lab|plugins|local|secrets|\.state)(/|$)'It prints nothing. No
.env,.lab/,plugins/,local/,secrets/or.state/path is staged, and no license, key or certificate. Unstage what it prints withgit restore --staged <path>. A commit has the person's own name and email, and no tool as author, co-author or credit. -
For a new add-on, setup or playground, confirm that the documentation that describes what changed is up to date. For a playground,
testedholds the versions it was checked on, and the versions and the time of its first start go under "Tried on" in the description. CI starts it on each set once a maintainer has approved the run (CONTRIBUTING.md, "What CI does"): say so. -
Print the description. Read
.github/PULL_REQUEST_TEMPLATE.mdand fill its fields: under "What and why", what the change does and why, with the issue it closes if there is one. Under "Checklist", tick only what you did in this run. Print the result for the person to paste. -
Stop there. When the person asks you to propose it, fork the repository if you cannot push, and follow
CONTRIBUTING.mdfor the branch, the commit message and the pull request. A branch that the Lab UI's Share made is already pushed (lab/<id>-<yyyymmdd>): open the pull request from it.
04 同仓库更多 Skills
acme-bakery-complaint-handling
How the Acme Bakery assistant takes a customer complaint. It listens, records the facts, says what happens next and hands the case to a teller when money or a card is involved. Use when a customer is unhappy, disputes a charge or reports a mistake.
share-item
Shares a personal Gravitee Lab add-on, setup or playground to a catalog, as a branch to propose or a copy into a folder.
prepare-pull-request
Prepares a Gravitee Lab change for review by running the checks that match it and printing the pull request description.
new-setup
Creates a Gravitee Lab setup, personal or shared, when someone wants add-ons that start and stop as one.
new-playground
Creates a Gravitee Lab playground, personal or shared, when someone wants a use case with its apps, sample data and guide.
new-catalog
Creates a Gravitee Lab catalog, a folder of add-ons, setups and playgrounds to keep or to share, when someone has built something and has nowhere to put it.