Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create Code style guide.md #10176

Merged
merged 2 commits into from
Aug 24, 2023
Merged

Create Code style guide.md #10176

merged 2 commits into from
Aug 24, 2023

Conversation

aveline
Copy link
Contributor

@aveline aveline commented Aug 22, 2023

First draft of a code style guide to help with consistency

First draft of code style guide

Co-Authored-By: Aaron Casanova <[email protected]>
@aveline aveline requested a review from sam-b-rose August 23, 2023 14:37
Copy link
Member

@sam-b-rose sam-b-rose left a 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.
Copy link
Member

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?

Copy link
Contributor Author

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

documentation/Code style guide.md Outdated Show resolved Hide resolved
@aveline aveline merged commit 338eed4 into main Aug 24, 2023
@aveline aveline deleted the code-style-guide branch August 24, 2023 14:35
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 <[email protected]>
Co-authored-by: Sam Rose <[email protected]>
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