handbook gudeline: reuse existing design patterns#15418
Open
corywatilo wants to merge 3 commits intomasterfrom
Open
handbook gudeline: reuse existing design patterns#15418corywatilo wants to merge 3 commits intomasterfrom
corywatilo wants to merge 3 commits intomasterfrom
Conversation
Collaborator
corywatilo
commented
Mar 2, 2026
- avoid one-offs
Contributor
Deploy preview
Push a fix or re-run the workflow to try again. Common culprits
|
Contributor
|
Vale prose linter → found 1 errors, 7 warnings, 0 suggestions in your markdown Full report → Copy the linter results into an LLM to batch-fix issues. Linter being weird? Update the rules!
|
| Line | Severity | Message | Rule |
|---|---|---|---|
| 11:4 | warning | 'v0.1 or v2?' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 17:5 | warning | 'v0.1' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 19:232 | warning | Use American English. Use 'judgment' instead of 'judgement'. | PostHogBase.AmericanEnglish |
| 21:5 | warning | 'MVP' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 27:5 | warning | 'v2' heading should be in sentence case, and product names should be capitalized. | PostHogBase.SentenceCase |
| 39:107 | error | Hi, Andy here... use an en dash ( – ) with spaces. On Mac, holding down the Option and hyphen key will give you an en dash. | PostHogBase.EnDash |
| 57:226 | warning | 'UIs' is a possible misspelling. | PostHogBase.Spelling |
| 69:40 | warning | 'commonon' is a possible misspelling. | PostHogBase.Spelling |
adamleithp
approved these changes
Mar 2, 2026
pauldambra
approved these changes
Mar 3, 2026
Member
pauldambra
left a comment
There was a problem hiding this comment.
suggestion on wording but 👍
|
|
||
| In any case, always copy existing UI patterns instead of creating new ones. Don't create a new version of something just because it's more convenient for your product. Take a few moments to look around how other products handle using the same component and copy the existing paradigm. This includes things like placement, sizing, and colors. | ||
|
|
||
| Avoid cramming in custom elements into commonon existing patterns just because there's space for something else. Creating one-offs leads to an inconsistent experience and confusion for end users. There are rare cases where you should deviate from this pattern. Before you do, always check in with the <SmallTeam name="platform-ux" /> to see if there's a better pattern to follow. |
Member
There was a problem hiding this comment.
Suggested change
| Avoid cramming in custom elements into commonon existing patterns just because there's space for something else. Creating one-offs leads to an inconsistent experience and confusion for end users. There are rare cases where you should deviate from this pattern. Before you do, always check in with the <SmallTeam name="platform-ux" /> to see if there's a better pattern to follow. | |
| Avoid cramming in custom elements into common existing patterns just because there's space for something else. Creating one-offs leads to an inconsistent experience and confusion for end users. There are rare cases where you should deviate from this pattern. Before you do, always check in with the <SmallTeam name="platform-ux" /> to see if there's a better pattern to follow. |
|
|
||
| --- | ||
|
|
||
| In any case, always copy existing UI patterns instead of creating new ones. Don't create a new version of something just because it's more convenient for your product. Take a few moments to look around how other products handle using the same component and copy the existing paradigm. This includes things like placement, sizing, and colors. |
Member
There was a problem hiding this comment.
Suggested change
| In any case, always copy existing UI patterns instead of creating new ones. Don't create a new version of something just because it's more convenient for your product. Take a few moments to look around how other products handle using the same component and copy the existing paradigm. This includes things like placement, sizing, and colors. | |
| In any case, prefer copying existing UI patterns instead of creating new ones. This means users' muscle memory will work for your scene when they first come to it. | |
| Don't create a new version of something just because it's more convenient for your product. Take a few moments to look around how other products handle using the same component and copy the existing paradigm. This includes things like placement, sizing, and colors. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.