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

Docs: Add section about adding new dependencies to WordPress packages #16876

Merged
merged 2 commits into from
Aug 5, 2019

Conversation

gziolo
Copy link
Member

@gziolo gziolo commented Aug 2, 2019

Description

This PR adds a section about adding new dependencies to WordPress packages. See new section's preview:
https://github.com/WordPress/gutenberg/blob/a300ed9530b7b4746924194b75117678e3592cc7/packages/README.md#adding-new-dependencies

I came up to the conclusion that this needs to be explained explicitly after talking to @dsifford. He had some issues when he wanted to add a new dependency to one of the packages. I hope all the proposed changes will make it easier for future contributors.

@gziolo gziolo added [Type] Developer Documentation Documentation for developers npm Packages Related to npm packages labels Aug 2, 2019
@gziolo gziolo requested review from ntwb, nerrad and dsifford August 2, 2019 09:37
@gziolo gziolo self-assigned this Aug 2, 2019
@gziolo gziolo requested a review from chrisvanpatten August 2, 2019 09:38
Copy link
Contributor

@dsifford dsifford left a comment

Choose a reason for hiding this comment

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

LGTM 👍

Copy link
Contributor

@chrisvanpatten chrisvanpatten left a comment

Choose a reason for hiding this comment

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

A few grammar nits, but this is great and super helpful!

packages/README.md Outdated Show resolved Hide resolved
packages/README.md Outdated Show resolved Hide resolved
packages/README.md Outdated Show resolved Hide resolved
Co-Authored-By: Chris Van Patten <[email protected]>
@gziolo
Copy link
Member Author

gziolo commented Aug 3, 2019

A few grammar nits, but this is great and super helpful!

They should hire you at Grammarly to improve their system which catches grammar issues, thanks for all corrections. 😄

Copy link
Contributor

@chrisvanpatten chrisvanpatten left a comment

Choose a reason for hiding this comment

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

🚢!

@gziolo gziolo merged commit eb84467 into master Aug 5, 2019
@gziolo gziolo deleted the update/docs-adding-deps-packages branch August 5, 2019 02:35
@youknowriad youknowriad added this to the Gutenberg 6.3 milestone Aug 9, 2019
gziolo added a commit that referenced this pull request Aug 29, 2019
…#16876)

* Docs: Add section about adding new dependencies to WordPress packages

* Apply suggestions from code review

Co-Authored-By: Chris Van Patten <[email protected]>
gziolo added a commit that referenced this pull request Aug 29, 2019
…#16876)

* Docs: Add section about adding new dependencies to WordPress packages

* Apply suggestions from code review

Co-Authored-By: Chris Van Patten <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
npm Packages Related to npm packages [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants