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

Components: add TypeScript refactor guidelines #40153

Merged
merged 14 commits into from
Apr 25, 2022

Conversation

ciampo
Copy link
Contributor

@ciampo ciampo commented Apr 7, 2022

What?

Add first version of the guidelines for refactoring components to TypeScript (see #35744 for more details).

Why?

Have a standardized way of approaching the refactor, make it easier for folks to contribute.

Testing Instructions

Read the newly added docs (no runtime changes).

@ciampo ciampo added [Type] Developer Documentation Documentation for developers [Package] Components /packages/components [Feature] Component System WordPress component system labels Apr 7, 2022
@ciampo ciampo self-assigned this Apr 7, 2022
@ciampo
Copy link
Contributor Author

ciampo commented Apr 7, 2022

@mirka I've added my initial notes, even if they are definitely a bit rough and incomplete.

We can use this PR to collaborate / add our own insights !

Copy link
Member

@mirka mirka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wonderful! Added some suggestions.

packages/components/CONTRIBUTING.md Outdated Show resolved Hide resolved
packages/components/CONTRIBUTING.md Show resolved Hide resolved
packages/components/CONTRIBUTING.md Outdated Show resolved Hide resolved
packages/components/CONTRIBUTING.md Outdated Show resolved Hide resolved
packages/components/CONTRIBUTING.md Outdated Show resolved Hide resolved
packages/components/CONTRIBUTING.md Outdated Show resolved Hide resolved
packages/components/CONTRIBUTING.md Outdated Show resolved Hide resolved
@ciampo ciampo marked this pull request as ready for review April 22, 2022 13:03
@ciampo ciampo requested a review from ajitbohra as a code owner April 22, 2022 13:03
@ciampo ciampo requested a review from mirka April 22, 2022 13:03
@ciampo
Copy link
Contributor Author

ciampo commented Apr 22, 2022

All feedback has been addressed (only this comment still potentially pending).

@mirka, do you think we should still refine / add anything to these guidelines for now? Otherwise we could go ahead, merge them and open new, small PRs every time we feel like making any improvements in the future

Copy link
Member

@mirka mirka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I think this is already pretty useful! Thanks for working on it. Let's merge 🚢

@ciampo ciampo merged commit dc3d29f into trunk Apr 25, 2022
@ciampo ciampo deleted the feat/component-typescript-migration-guide branch April 25, 2022 07:13
@github-actions github-actions bot added this to the Gutenberg 13.2 milestone Apr 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Feature] Component System WordPress component system [Package] Components /packages/components [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants