32 Commits

Author SHA1 Message Date
Patrik Oldsberg b2fd456ba4 docs: clarify that changesets should not reference internal code details
Update changeset writing guidance in AGENTS.md, CONTRIBUTING.md, and
REVIEWING.md to explicitly state that changeset messages should never
mention internal implementation details such as internal function names,
class names, variable names, or other code symbols. Messages should
describe user-facing behavior changes in plain language.

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
2026-04-16 23:21:56 +02:00
Patrik Oldsberg 8f9c1d64b8 verify-links: catch broken anchors, directory links, and invisible characters (#33713)
* verify-links: catch broken anchors, directory links, and invisible characters

Enhances the link verification script to catch several categories of
broken links that were previously missed:

- Broken anchors (cross-file and same-file) by extracting heading slugs
  from target documents and verifying anchors resolve
- Directory links missing index.md suffix within docs/
- Invisible/zero-width characters in URLs
- Case-sensitive anchor mismatches

Also strips fenced code blocks before scanning for links to avoid false
positives, and handles duplicate heading slug deduplication (GitHub and
Docusaurus append -1, -2, etc.).

Fixes a few newly-caught broken links in existing docs.

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor

* Fix CodeQL incomplete multi-character sanitization alert

Apply HTML tag stripping in a loop so that nested fragments
like <scr<script>ipt> are fully removed.

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor

---------

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2026-04-03 17:48:40 +02:00
Patrik Oldsberg 225d348dec REVIEWING.md: updates and more explicit insrtuctions for new review process
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2026-02-07 15:16:21 +01:00
Patrik Oldsberg d8b560ae41 Merge pull request #32370 from backstage/rugvip/reviews-v2
REVIEWING.md: introduce new review process
2026-02-02 17:12:45 +01:00
Patrik Oldsberg ed2a168fc3 REVIEWING.md: update to use waiting-for:* labels
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2026-02-02 00:54:25 +01:00
Charles de Dreuille 3342b2af29 Add new changelog format for BUI
Signed-off-by: Charles de Dreuille <charles.dedreuille@gmail.com>
2026-01-23 15:10:25 +00:00
Patrik Oldsberg 7f88082b14 Update REVIEWING.md
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2026-01-20 00:20:05 +01:00
Patrik Oldsberg 07a1788a17 REVIEWING.md: review updates and addition about using "request changes"
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2026-01-19 22:30:00 +01:00
Patrik Oldsberg 1965940305 Apply suggestions from code review
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2026-01-19 15:55:04 +01:00
Patrik Oldsberg c341d36e08 REVIEWING.md: introduce new review process
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2026-01-19 15:15:27 +01:00
secustor d427b56073 update docs
Signed-off-by: secustor <sebastian@poxhofer.at>
2024-09-23 14:41:42 +02:00
secustor 23c2602fc3 update docs
Signed-off-by: secustor <sebastian@poxhofer.at>
2024-09-23 14:41:42 +02:00
secustor 30c2be9bcd fix: Update @microsoft/api-extractor and use their api report resolution
Signed-off-by: secustor <sebastian@poxhofer.at>
2024-09-23 14:41:24 +02:00
Andre Wanlin d8133b281d Added Plugin Directory Submission Tips
Signed-off-by: Andre Wanlin <awanlin@spotify.com>
2023-11-23 13:37:28 -06:00
Patrik Oldsberg 4e36abef14 cli: remove support for --experimental-type-build
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2023-10-22 11:49:44 +02:00
Fredrik Adelöw 4b1420834f update reviewing.md
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2023-08-22 10:12:11 +02:00
Fredrik Adelöw 4b4bf895c5 review updates
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2022-11-16 14:37:17 +01:00
Fredrik Adelöw cce755b5af Update versioning policy to treat utility/service API additions as non-breaking
Co-authored-by: Patrik Oldsberg <poldsberg@gmail.com>
Co-authored-by: Johan Haals <johan.haals@gmail.com>
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2022-11-16 12:10:15 +01:00
Patrik Oldsberg d6e5523326 Update REVIEWING.md
Co-authored-by: Fredrik Adelöw <freben@gmail.com>
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-10-20 09:50:28 +02:00
Patrik Oldsberg ff621dbb5b Update REVIEWING.md
Co-authored-by: Fredrik Adelöw <freben@gmail.com>
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-10-20 09:49:38 +02:00
Patrik Oldsberg dacd03daf8 Update REVIEWING.md
Co-authored-by: Fredrik Adelöw <freben@gmail.com>
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-10-20 09:45:38 +02:00
Patrik Oldsberg 599b9d0069 Update REVIEWING.md
Co-authored-by: Fredrik Adelöw <freben@gmail.com>
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-10-20 09:41:45 +02:00
Patrik Oldsberg 1fc2b3efe2 Update REVIEWING.md
Co-authored-by: Phil Kuang <pkuang@factset.com>
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-10-19 16:30:03 +02:00
Patrik Oldsberg b573005f62 Update REVIEWING.md
Co-authored-by: Phil Kuang <pkuang@factset.com>
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-10-19 16:26:35 +02:00
Patrik Oldsberg c20e2b2f33 Update REVIEWING.md
Co-authored-by: Phil Kuang <pkuang@factset.com>
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-10-19 16:26:07 +02:00
Patrik Oldsberg e0aa20ab12 REVIEWING: use valid png link
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-10-19 16:21:12 +02:00
Patrik Oldsberg 1156ed8139 REVIEWING: couple more sections and tweaks
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-10-19 14:22:46 +02:00
Patrik Oldsberg 78577cb46e REVIEWING: expand code style section
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-10-19 13:22:41 +02:00
Patrik Oldsberg 8a4f4d1f30 REVIEWING: versioning policy and changeset bump sections
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-10-19 13:19:00 +02:00
Patrik Oldsberg b3d522b0a8 REVIEWING: example tweaks talk about behavioral changes
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-10-19 10:42:40 +02:00
Patrik Oldsberg d383afb372 REVIEWING: add typescript section
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-10-18 19:50:43 +02:00
Patrik Oldsberg 6aec3eb1b0 initial REVIEWING.md
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-10-14 15:22:26 +01:00