This repository was archived by the owner on Sep 30, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Create Code style guide.md #10176
Merged
Merged
Create Code style guide.md #10176
Conversation
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
First draft of code style guide Co-Authored-By: Aaron Casanova <32409546+aaronccasanova@users.noreply.github.com>
sam-b-rose
approved these changes
Aug 23, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Excellent start! Thank you for adding this much-needed and long-overdue resource 🙌
- Organize code files and directories logically and consistently. | ||
- Use meaningful and descriptive file and directory names. | ||
- Follow the recommended folder structure for components, utilities, and tests. | ||
- Import modules and components in alphabetical order. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We do already use the ESLint import/order rule, which looks like it has an option for alphabetizing. Can we should enable this and remove this point?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm all for it
Co-authored-by: Sam Rose <11774595+samrose3@users.noreply.github.com>
sam-b-rose
added a commit
that referenced
this pull request
Aug 28, 2023
* main: Fix rename prop migration (#10215) Update translations: default (#10219) [Avatar] Override SE23 background override with imageHasLoaded (#10211) Create Code style guide.md (#10176) ActionsList filtering (#9907) Version Packages (#10078) Support dynamic fontsizes in iOS devices (#10181) Fix migration resolution path (#10188) [Button] Deprecate connectedDisclosure (#10183) Update sandbox.md (#10186) Allow migrator to target subcomponents and change prop values (#10071) Remove `polaris-cli` and `polaris-codemods` packages (#10101) Bump loader-utils from 1.4.0 to 1.4.2 (#7725) Bump deep-object-diff from 1.1.7 to 1.1.9 (#7734) Bump decode-uri-component from 0.2.0 to 0.2.2 (#7832) Bump webpack from 5.72.0 to 5.76.0 (#8667) Bump fastify from 4.5.3 to 4.15.0 (#8750) [Modal] Activator no longer wrapped in Box (#10086) Fix icon optimize config (#10087) [ResourceList] Remove layout jank when bulk actions enabled and item selected
sam-b-rose
added a commit
that referenced
this pull request
Aug 28, 2023
* main: Fix rename prop migration (#10215) Update translations: default (#10219) [Avatar] Override SE23 background override with imageHasLoaded (#10211) Create Code style guide.md (#10176) ActionsList filtering (#9907) Version Packages (#10078) Support dynamic fontsizes in iOS devices (#10181) Fix migration resolution path (#10188) [Button] Deprecate connectedDisclosure (#10183) Update sandbox.md (#10186) Allow migrator to target subcomponents and change prop values (#10071) Remove `polaris-cli` and `polaris-codemods` packages (#10101) Bump loader-utils from 1.4.0 to 1.4.2 (#7725) Bump deep-object-diff from 1.1.7 to 1.1.9 (#7734) Bump decode-uri-component from 0.2.0 to 0.2.2 (#7832) Bump webpack from 5.72.0 to 5.76.0 (#8667) Bump fastify from 4.5.3 to 4.15.0 (#8750) [Modal] Activator no longer wrapped in Box (#10086) Fix icon optimize config (#10087) [ResourceList] Remove layout jank when bulk actions enabled and item selected
AnnaCheba
pushed a commit
to AnnaCheba/polaris
that referenced
this pull request
Apr 22, 2024
First draft of a code style guide to help with consistency --------- Co-authored-by: Aaron Casanova <32409546+aaronccasanova@users.noreply.github.com> Co-authored-by: Sam Rose <11774595+samrose3@users.noreply.github.com>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
First draft of a code style guide to help with consistency