Skip to content

docs: add 2nd-gen TypeScript style guide and research docs#6094

Closed
Rajdeepc wants to merge 2 commits intomainfrom
rajdeepc/docs-typescript-style-guide
Closed

docs: add 2nd-gen TypeScript style guide and research docs#6094
Rajdeepc wants to merge 2 commits intomainfrom
rajdeepc/docs-typescript-style-guide

Conversation

@Rajdeepc
Copy link
Copy Markdown
Contributor

@Rajdeepc Rajdeepc commented Mar 19, 2026

Summary

  • Add comprehensive TypeScript style guide (17 documents) covering file organization, class structure, decorators, types, rendering patterns, naming conventions, composition patterns, and debug validation for 2nd-gen component development
  • Include research documents for SWC-1419 (full pattern analysis across existing 2nd-gen components) and SWC-1420 (TypeScript guide planning)
  • Fix minor issues in existing contributor docs (TOC updates, linting-tools renumbering, field-label analysis rogue tag)

Motivation

Contributors (human and AI) need clear, consistent guidance for writing 2nd-gen components. These guides provide detailed conventions based on the Badge component as the reference implementation, with other 2nd-gen components shown where they demonstrate different patterns.

Related

Test plan

  • Verify all 17 TypeScript guide documents render correctly on GitHub
  • Verify TOC links in README files are valid
  • Verify linting-tools renumbering (02 -> 03) does not break existing links

Add comprehensive TypeScript style guide for 2nd-gen component
development covering file organization, class structure, decorators,
types, rendering patterns, naming conventions, composition patterns
(mixins, controllers, directives, interfaces), and debug validation.

All guides use the Badge component as the primary reference
implementation, with other 2nd-gen components shown where they
demonstrate different patterns.

Also includes research documents for SWC-1419 (full pattern analysis
across existing 2nd-gen components) and SWC-1420 (TypeScript guide
planning), plus minor fixes to existing contributor docs (TOC updates,
linting-tools renumbering for new TypeScript section, field-label
analysis tag fix).

Made-with: Cursor
@Rajdeepc Rajdeepc requested a review from a team as a code owner March 19, 2026 15:43
@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Mar 19, 2026

⚠️ No Changeset found

Latest commit: 6e05cf6

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Mar 19, 2026

📚 Branch Preview Links

🔍 First Generation Visual Regression Test Results

When a visual regression test fails (or has previously failed while working on this branch), its results can be found in the following URLs:

Deployed to Azure Blob Storage: pr-6094

If the changes are expected, update the current_golden_images_cache hash in the circleci config to accept the new images. Instructions are included in that file.
If the changes are unexpected, you can investigate the cause of the differences and update the code accordingly.

Remove SWC-1419 and SWC-1420 research documents and their references
from the project-planning README. These are AI-generated working
documents that should not be committed to the repository, per reviewer
feedback from marissahuysentruyt and rubencarvalho on #6067.

Made-with: Cursor
@caseyisonit caseyisonit added Status:Ready for review PR ready for review or re-review. High priority PR review PR is a high priority and should be reviewed ASAP labels Mar 23, 2026
@caseyisonit caseyisonit self-assigned this Mar 23, 2026
@caseyisonit
Copy link
Copy Markdown
Contributor

closing this as it didn't address the feedback from the original PR and would cause too much friction updating

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

High priority PR review PR is a high priority and should be reviewed ASAP Status:Ready for review PR ready for review or re-review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants