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.

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

Jump to bottom

Components: add guidelines on how to write a component's README to the contributing guidelines #34694

Closed
2 tasks
Tracked by #34304
ciampo opened this issue Sep 9, 2021 · 0 comments · Fixed by #34847
Closed
2 tasks
Tracked by #34304

Components: add guidelines on how to write a component's README to the contributing guidelines #34694

ciampo opened this issue Sep 9, 2021 · 0 comments · Fixed by #34847
Assignees
@ciampo
Labels
[Feature] Component System WordPress component system [Package] Components /packages/components [Type] Developer Documentation Documentation for developers

Comments

@ciampo
Copy link
Contributor

ciampo commented Sep 9, 2021 •
edited
Loading

What

As requested in #34624 (comment), it'd be great of the contributing guidelines had a section on how to write consistent documentation for components in @wordpress/components

Why

Consistency is key, especially when multiple contributors are going to work on this package

A/C

  • Agree on a common format for docs and READMEs
  • Add a section to the @wordpress/component's package Contributing Guildelines
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ciampo ciampo

Labels
[Feature] Component System WordPress component system [Package] Components /packages/components [Type] Developer Documentation Documentation for developers
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Adding example readme template to contributing guidelines. ryanwelcher/gutenberg
1 participant
@ciampo