Skip to content

Commit

Permalink
Docs; Organize contributors section using READMEs (#29688)
Browse files Browse the repository at this point in the history
* Organize contributors section using READMEs

* Update links to contributing sections
  • Loading branch information
mkaz authored Mar 10, 2021
1 parent fed1fb8 commit 749f785
Show file tree
Hide file tree
Showing 8 changed files with 17 additions and 17 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ Welcome to WordPress' Gutenberg project! We hope you join us in creating the fut

To learn all about contributing to the Gutenberg project, see the [Contributor Guide](/docs/contributors/README.md). The handbook includes all the details you need to get setup and start shaping the future of web publishing.

- Code? See the [developer section](/docs/contributors/code/code.md).
- Code? See the [developer section](/docs/contributors/code/README.md).

- Design? See the [design section](/docs/contributors/design/design.md).
- Design? See the [design section](/docs/contributors/design/README.md).

- Documentation? See the [documentation section](/docs/contributors/documentation/documentation.md).
- Documentation? See the [documentation section](/docs/contributors/documentation/README.md).

- Triage? We need help reviewing existing issues to make sure they’re relevant and actionable. Triage is an important contribution because it allows us to work on the highest priority issues. To learn more, please see the [triaging issues section](docs/contributors/triage.md).

Expand Down
6 changes: 3 additions & 3 deletions docs/contributors/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ Gutenberg is a sub-project of Core WordPress. Please see the [Core Contributor H

Find the section below based on what you are looking to contribute:

- **Code?** See the [developer section](/docs/contributors/code/code.md).
- **Code?** See the [developer section](/docs/contributors/code/README.md).

- **Design?** See the [design section](/docs/contributors/design/design.md).
- **Design?** See the [design section](/docs/contributors/design/README.md).

- **Documentation?** See the [documentation section](/docs/contributors/documentation/documentation.md)
- **Documentation?** See the [documentation section](/docs/contributors/documentation/README.md)

- **Triage Support?** See the [triaging issues section](/docs/contributors/triage.md)

Expand Down
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ This way they will be properly handled in all three aforementioned contexts.

Use the full directory and filename from the Gutenberg repository, not the published path; the Block Editor Handbook creates short URLs—you can see this in the tutorials section. Likewise, the `readme.md` portion is dropped in the handbook, but should be included in links.

An example, the link to this page is: `/docs/contributors/documentation/documentation.md`
An example, the link to this page is: `/docs/contributors/documentation/README.md`

### Code Examples

Expand Down
6 changes: 3 additions & 3 deletions docs/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -1754,7 +1754,7 @@
{
"title": "Code Contributions",
"slug": "code",
"markdown_source": "../docs/contributors/code/code.md",
"markdown_source": "../docs/contributors/code/README.md",
"parent": "contributors"
},
{
Expand Down Expand Up @@ -1820,7 +1820,7 @@
{
"title": "Design Contributions",
"slug": "design",
"markdown_source": "../docs/contributors/design/design.md",
"markdown_source": "../docs/contributors/design/README.md",
"parent": "contributors"
},
{
Expand All @@ -1838,7 +1838,7 @@
{
"title": "Documentation Contributions",
"slug": "documentation",
"markdown_source": "../docs/contributors/documentation/documentation.md",
"markdown_source": "../docs/contributors/documentation/README.md",
"parent": "contributors"
},
{
Expand Down
8 changes: 4 additions & 4 deletions docs/toc.json
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@
{ "docs/how-to-guides/platform/README.md": [
{ "docs/how-to-guides/platform/custom-block-editor/README.md": [
{ "docs/how-to-guides/platform/custom-block-editor/tutorial.md": [] }
] }
] }
] },
{ "docs/how-to-guides/designers/README.md": [
{ "docs/how-to-guides/designers/block-design.md": [] },
Expand Down Expand Up @@ -145,7 +145,7 @@
] }
] },
{ "docs/contributors/README.md": [
{ "docs/contributors/code/code.md": [
{ "docs/contributors/code/README.md": [
{ "docs/contributors/code/getting-started-with-code-contribution.md": [] },
{ "docs/contributors/code/git-workflow.md": [] },
{ "docs/contributors/code/coding-guidelines.md": [] },
Expand All @@ -157,11 +157,11 @@
{ "docs/contributors/code/native-mobile.md": [] },
{ "docs/contributors/code/getting-started-native-mobile.md": [] }
] },
{ "docs/contributors/design/design.md": [
{ "docs/contributors/design/README.md": [
{ "docs/contributors/design/the-block.md": [] },
{ "docs/contributors/design/reference.md": [] }
] },
{ "docs/contributors/documentation/documentation.md": [
{ "docs/contributors/documentation/README.md": [
{ "docs/contributors/documentation/copy-guide.md": [] }
] },
{ "docs/contributors/triage.md": [] },
Expand Down
6 changes: 3 additions & 3 deletions packages/components/src/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ You can contribute by adding, modifying, or deprecating components, as well as h

## Does it belong in the component library?

A component library should include components that are generic and flexible enough to work across a variety of products. It should include what’s shared across many products and omit what’s not.
A component library should include components that are generic and flexible enough to work across a variety of products. It should include what’s shared across many products and omit what’s not.

To determine if a component should be added, ask yourself:

Expand Down Expand Up @@ -37,7 +37,7 @@ Once the team has discussed and approved the change, it's time to start implemen

1. **Provide a rationale**: Explain how your component will add value to the system and the greater product ecosystem. Be sure to include any user experience and interaction descriptions.
2. **Draft documentation**: New components need development, design, and accessibility guidelines. Additionally, if your change adds additional behavior or expands a component’s features, those changes will need to be fully documented as well. Read through existing component documentation for examples. Start with a rough draft, and reviewers will help polish documentation.
3. **Provide working code**: The component or enhancement must be built in React. See the [developer contribution guidelines](https://github.com/WordPress/gutenberg/blob/HEAD/docs/contributors/code/code.md).
3. **Provide working code**: The component or enhancement must be built in React. See the [developer contribution guidelines](https://github.com/WordPress/gutenberg/blob/HEAD/docs/contributors/code/README.md).
4. **Create a design spec**: Create sizing and styling annotations for all aspects of the component. This spec should provide a developer with everything they need to create the design in code. [Figma automatically does this for you](https://help.figma.com/article/32-developer-handoff).
5. **Create a Figma component**: Any new components or changes to existing components will be mirrored in the [WordPress Components Figma library](https://www.figma.com/file/ZtN5xslEVYgzU7Dd5CxgGZwq/WordPress-Components?node-id=735%3A0), so we’ll need to update the Figma library and publish the changes. Please follow the [guidelines](https://www.figma.com/file/ZtN5xslEVYgzU7Dd5CxgGZwq/WordPress-Components?node-id=746%3A38) for contributing to the Figma libraries.

Expand All @@ -53,7 +53,7 @@ Before a component is published it will need to be fine-tuned:

### Quality assurance

To ensure quality, each component should be tested. The testing process should be done during the development of the component and before the component is published.
To ensure quality, each component should be tested. The testing process should be done during the development of the component and before the component is published.

- **Accessibility**: Has the design and implementation accounted for accessibility? Please use the [WordPress accessibility guidelines](https://make.wordpress.org/accessibility/handbook/best-practices/). You must use the "Needs Accessibility Feedback" label and get a review from the accessibility team. It's best to request a review early (at the documentation stage) in order to ensure the component is designed inclusively from the outset.
- **Visual quality**: Does the component apply visual style — color, typography, icons, space, borders, and more — using appropriate variables, and does it follow [visual guidelines](https://make.wordpress.org/design/handbook/design-guide/)? You must use the "Needs Design Feedback" label and get a review from the design team.
Expand Down

0 comments on commit 749f785

Please sign in to comment.