Skip to content

Core tenets of web component development#2673

Open
jamieomaguire wants to merge 6 commits intomainfrom
dsw-3506-wc-tenets
Open

Core tenets of web component development#2673
jamieomaguire wants to merge 6 commits intomainfrom
dsw-3506-wc-tenets

Conversation

@jamieomaguire
Copy link
Copy Markdown
Contributor

@jamieomaguire jamieomaguire commented Jan 28, 2026

This is a proof of concept document outlining what I believe to be our core tenets driving how we author the PIE DS web components.

These are patterns, opinions and guiding principles we have developed over the last few years through trial and error. Not every tenet is 100% enforced. For example, the first tenet regarding Controlled components and a deliberate omission of internal state handling is something we have only recently discussed should be a pattern moving forward.

Therefore, this document is not an introduction of rules to go back and enforce/refactor to adhere to.

Instead, I hope this can serve as a starting point for discussing and intentionally documenting how we want our components to be built both within the team and by contributors.

Please be critical of this document and scrutinise it all!

@jamieomaguire jamieomaguire requested a review from a team as a code owner January 28, 2026 15:17
@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Jan 28, 2026

⚠️ No Changeset found

Latest commit: 5dfb617

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

@pie-design-system-bot
Copy link
Copy Markdown
Contributor

pie-design-system-bot commented Jan 28, 2026

Fails
🚫

PR Title Validation Failed

The PR title should follow the same convention used for commits, e.g.:
type(scope): TICKET-123 title where TICKET-123 is a valid ticket ID.

Note: Ticket IDs cannot be all zeros (e.g. DSW-000 is not allowed).

Current title: Core tenets of web component development

Generated by 🚫 dangerJS against 5dfb617

@jamieomaguire jamieomaguire self-assigned this Jan 28, 2026
@jamieomaguire jamieomaguire added work-in-progress This pull request is still a work in progress and may not be ready for review help-wanted proof-of-concept labels Jan 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

help-wanted proof-of-concept work-in-progress This pull request is still a work in progress and may not be ready for review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants