@worldresources/wri-design-systems 2.191.21 → 2.191.22
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +19 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -476,14 +476,18 @@ npm publish
|
|
|
476
476
|
|
|
477
477
|
## PR Label Rules
|
|
478
478
|
|
|
479
|
-
Use exactly one versioning label on every PR. The label drives the npm version bump when the PR is merged into `main`.
|
|
479
|
+
Use exactly one versioning label on every contributor PR. The label drives the npm version bump workflow when the PR is merged into `main`.
|
|
480
480
|
|
|
481
481
|
**How it works**
|
|
482
482
|
|
|
483
483
|
- Open a PR and add **one** of the labels below.
|
|
484
484
|
- The PR Label Guard workflow enforces that exactly one label is present.
|
|
485
|
-
- On merge, the Release & Publish workflow
|
|
485
|
+
- On merge, the Release & Publish workflow opens an automated release PR with labels:
|
|
486
|
+
- `auto-release`
|
|
487
|
+
- the same bump label from the merged PR (`major`, `minor`, or `patch`)
|
|
488
|
+
- Merge that release PR to trigger tag creation, npm publish, and GitHub release notes.
|
|
486
489
|
- `no-bump` skips all versioning and publishing.
|
|
490
|
+
- PR checks (`test`, `lint`, `pr-label-check`) are skipped for PRs labeled `auto-release`.
|
|
487
491
|
|
|
488
492
|
**Label guide**
|
|
489
493
|
|
|
@@ -491,5 +495,18 @@ Use exactly one versioning label on every PR. The label drives the npm version b
|
|
|
491
495
|
- `minor`: backwards-compatible feature or API additions (new component/prop), or behavior changes that may affect usage but are not breaking
|
|
492
496
|
- `major`: breaking changes (removed/renamed props, changed required behavior, incompatible defaults)
|
|
493
497
|
- `no-bump`: documentation-only or internal changes that should not publish
|
|
498
|
+
- `auto-release`: internal automation label for generated release PRs (do not use manually on regular PRs)
|
|
494
499
|
|
|
495
500
|
If you are unsure, choose `minor` and leave a note in the PR for review.
|
|
501
|
+
|
|
502
|
+
## PR Description With AI Skill
|
|
503
|
+
|
|
504
|
+
To get a solid PR description quickly, use the `pr-documentation` skill in your AI-enabled editor.
|
|
505
|
+
|
|
506
|
+
1. Ensure your branch is up to date and run:
|
|
507
|
+
`git diff main...HEAD`
|
|
508
|
+
2. Ask the assistant to use `pr-documentation` and summarize the current PR changes. Or ask "create a PR description for my changes"
|
|
509
|
+
3. Paste the generated result into the PR description using this structure:
|
|
510
|
+
`## What`, `## Why`, `## Changes`.
|
|
511
|
+
|
|
512
|
+
The `pr-documentation` skill is defined at [`.gemini/skills/pr-documentation/SKILL.md`](.gemini/skills/pr-documentation/SKILL.md) and [`.claude/skills/pr-documentation/SKILL.md`](.claude/skills/pr-documentation/SKILL.md) and is tailored for this repository workflow.
|