-
Notifications
You must be signed in to change notification settings - Fork 4.2k
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
Update @wordpress/components
package's contributing guidelines
#33960
Conversation
cc @griffbrad @sarayourfriend @diegohaz I've started writing down a draft for an update CONTRIBUTING guidelines for the It'd be great if you could give it a read and help expand on a few sections that, for now, I've only written a few notes for. |
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.
That's a great initiative. Thank you for starting looking at bringing some structure and better organization to @wordpress/components
👏🏻
e485ea6
to
0a36f58
Compare
You might want to split this PR. It's getting big already 😄 Let us know when it's ready for the final review. |
It's not quite there yet — yesterday we agreed that @diegohaz is going to contribute to the "composition", "API consistency" and potentially a "performance" section (I've updated the PR description to keep track of these tasks)
That makes sense! Let's wait for the bulk of the work to be done, and then we can make a decision on if/how to split this PR |
Actually, I was thinking more of merging sooner some parts that you consider ready and continue working on the rest in this PR 😄 |
…ition" section into sub-sections
Co-authored-by: Haz <[email protected]> Co-authored-by: Greg Ziółkowski <[email protected]>
a834aaf
to
8c494c8
Compare
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.
This is looking great. Let’s land and iterate as discussed above.
Excellent work documenting every detail ❤️
@@ -10,7 +10,7 @@ Install the module | |||
npm install @wordpress/components --save | |||
``` | |||
|
|||
_This package assumes that your code will run in an **ES2015+** environment. If you're using an environment that has limited or no support for ES2015+ such as IE browsers then using [core-js](https://github.com/zloirock/core-js) will add polyfills for these methods._ | |||
_This package assumes that your code will run in an **ES2015+** environment. If you're using an environment that has limited or no support for such language features and APIs, you should include [the polyfill shipped in `@wordpress/babel-preset-default`](/packages/babel-preset-default#polyfill) in your code._ |
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.
Good job with this note’s update. I need to copy it to all other packages 😃
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.
Opened #34878 to propagate the same change to other packages.
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.
Awesome! Great work @ciampo!
* trunk: [RNMobile][Embed block] Add device's locale to preview content (#33858) Update AlignmentMatrixControl docs post merge. (#34662) Chore: Update caniuse package to the latest version (#34685) Chore: Move `react-native-url-polyfill` to dev dependencies (#34687) Site Editor - add basic plugin support (#34460) ESLint Plugin: Use Jest related rules only when the package is installed (#33120) Update `@wordpress/components` package's contributing guidelines (#33960) chore(release): publish Update changelog files [RNMobile] [Embed block] Fix content disappearing on Android when switching light/dark mode (#34207) Scripts: Convert legacy entry point arguments for compatibility with webpack 5 (#34264) Update justication control in `flex` layout (#34651) Block Editor: Rename experimental prop used in `BlockControls` (#34644) Fix social links deprecation (#34639)
Description
Update the
README
andCONTRIBUTING
files in the@wordpress/components
package to reflect the latest guiding principles used by the package maintainers.Next steps (to be carried out in separate PRs):
@diegohaz to work on:
@ciampo to work on:
packages/components/src/
into the new guildlinesHow has this been tested?
Human reading!
Screenshots
N/A
Types of changes
New feature (updated / expanded docs)
Checklist:
*.native.js
files for terms that need renaming or removal).