Skip to content

docs: add 🧪 pre-release tagging convention and badges#797

Merged
lcottercertinia merged 1 commit into
certinia:mainfrom
lukecotter:chore-pre-release-doc-tagging
Jun 1, 2026
Merged

docs: add 🧪 pre-release tagging convention and badges#797
lcottercertinia merged 1 commit into
certinia:mainfrom
lukecotter:chore-pre-release-doc-tagging

Conversation

@lukecotter
Copy link
Copy Markdown
Collaborator

📝 PR Overview

Establishes a lightweight convention for marking pre-release-only features so stable Marketplace users aren't misled about what they can use today. Replaces the verbose per-feature blockquote callout with a compact, scoped inline 🧪 badge, and wires reminders into the PR template and contributor docs.

🛠️ Changes made

  • RELEASING.md — document the inline 🧪 badge convention (README-only, applied at the smallest accurate scope), replacing the old blockquote callout; add the "mark in the same PR" guidance.
  • README.md — add the 🧪 legend near the top and tag current pre-release-only features; free up the misused 🧪 on the CLI install option.
  • PR template — add a Docs checklist item reminding authors to badge pre-release-only features.
  • CONTRIBUTING.md — add a short "New Features" note pointing to the convention.
  • .gitignore — consolidate tsconfig.tsbuildinfo into the root ignore (removed from lana/ and log-viewer/).

🧩 Type of change (check all applicable)

  • 🐛 Bug fix - something not working as expected
  • ✨ New feature – adds new functionality
  • ♻️ Refactor - internal changes with no user impact
  • ⚡ Performance Improvement
  • 📝 Documentation - README or documentation site changes
  • 🔧 Chore - dev tooling, CI, config
  • 💥 Breaking change

✅ Tests added?

  • 👍 yes
  • 🙅 no, not needed
  • 🙋 no, I need help

📚 Docs updated?

  • 🔖 README.md
  • 🔖 CHANGELOG.md
  • 📖 help site
  • 🧪 Marked any pre-release-only features (README 🧪 badge — see RELEASING.md)
  • 🙅 not needed

- introduce inline `🧪` badge convention in RELEASING.md (README-only, scoped) replacing the verbose blockquote callout
- tag pre-release-only features in README.md and add the badge legend
- add PR-template checklist item and CONTRIBUTING note to mark features in the same PR
- consolidate `tsconfig.tsbuildinfo` ignore into root `.gitignore`
@lcottercertinia lcottercertinia merged commit 450af73 into certinia:main Jun 1, 2026
5 checks passed
@lukecotter lukecotter deleted the chore-pre-release-doc-tagging branch June 1, 2026 18:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants