Skip to content

Update @wordpress/components package's contributing guidelines #33960

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.

Sign up for GitHub

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

Merged
ciampo merged 35 commits into from
Sep 9, 2021
Merged

Update @wordpress/components package's contributing guidelines #33960

Changes from 1 commit
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
7e93e07
README: add notes
ciampo Aug 9, 2021
37e1759
README: add link to `CONTRIBUTING.md`
ciampo Aug 9, 2021
cefad1f
CONTRIBUTING: Add initial notes
ciampo Aug 9, 2021
02114ce
More notes into CONTRIBUTING
ciampo Aug 10, 2021
3d665fb
Update CONTRIBUTING
ciampo Aug 11, 2021
0fb4753
Add `enable` to boolean prefixes
ciampo Aug 12, 2021
00e2b35
Remove `View` suffix for styled components
ciampo Aug 12, 2021
17ccabe
Update folder structure: move styles and types into each subfolder
ciampo Aug 12, 2021
1459214
Less strict working about typescript, rename PolymorphicComponent to …
ciampo Aug 24, 2021
c6f6a24
Update packages/components/CONTRIBUTING.md
ciampo Aug 24, 2021
f533857
Refer to the repo testing overview docs in the unit test section
ciampo Sep 1, 2021
4c1c200
Update polyfill info
ciampo Sep 1, 2021
89a89d1
Remove "Components Structure" paragraph
ciampo Sep 1, 2021
5238a88
Reword text in "Folder structure" section, exclude shared utilities
ciampo Sep 1, 2021
7acc925
Folder structure schemes: name parent folders, remove useless sub-com…
ciampo Sep 1, 2021
6621f1e
Expand Storybook section
ciampo Sep 1, 2021
6f6d8de
Add details to soft deprecation strategy
ciampo Sep 1, 2021
9d0ece7
Misc smaller improvements
ciampo Sep 1, 2021
d394f5d
Fix typo
ciampo Sep 1, 2021
3359502
Expand hooks vs components section, move under composition
ciampo Sep 1, 2021
cfc843d
Move sub components naming convention under "APIs consistency" section
ciampo Sep 1, 2021
abf50ad
Add Polymorphic components sub-section, reorganise "Components compos…
ciampo Sep 1, 2021
0021dfc
Add more details about listing props through knobs in storybook
ciampo Sep 2, 2021
15f7023
Remove hyphen from subcomponents
ciampo Sep 2, 2021
4520f7e
Add content to the `Context System` section
ciampo Sep 2, 2021
95de8fb
comment out unfinied sections
ciampo Sep 3, 2021
5393b9a
Apply suggestions from code review
ciampo Sep 8, 2021
6647446
Comment out reference to the "composition section"
ciampo Sep 8, 2021
670ca6c
Rename "Emotion" section to "Styling"
ciampo Sep 8, 2021
e65518d
Updale unit test section to link directly to components snapshot testing
ciampo Sep 8, 2021
b6edc2e
Update the storybook section, adding more details on stories and knobs
ciampo Sep 8, 2021
e8bb18d
Link to the Coding Guidelines in the "Documentation" section
ciampo Sep 8, 2021
08cd356
remove note about relevance of SCSS-related docs in README
ciampo Sep 8, 2021
c34f731
Update context section with example snippets
ciampo Sep 8, 2021
8c494c8
Format internal links to absolute path format
ciampo Sep 8, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Comment out reference to the "composition section"
  • Loading branch information
@ciampo
ciampo committed Sep 8, 2021
commit 66474469b39466210d2596af1110719ea4e84602
5 changes: 4 additions & 1 deletion packages/components/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,10 @@ For an example of a component that follows these requirements, take a look at [`

#### TypeScript

We strongly encourage using TypeScript for all new components. Components should be typed using the `WordPressComponent` type (more details about polymorphism can be found above in the "Components composition" section).
We strongly encourage using TypeScript for all new components. Components should be typed using the `WordPressComponent` type.

<!-- TODO: add to the previous paragraph once the composision section gets added to this document.
(more details about polymorphism can be found above in the "Components composition" section). -->

#### Emotion

Expand Down