diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 09423bf3e011a5..942cc50b1d0a3a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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). diff --git a/docs/contributors/README.md b/docs/contributors/README.md index 7ce973af207fc2..08b0d3ca0dc421 100644 --- a/docs/contributors/README.md +++ b/docs/contributors/README.md @@ -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) diff --git a/docs/contributors/code/code.md b/docs/contributors/code/README.md similarity index 100% rename from docs/contributors/code/code.md rename to docs/contributors/code/README.md diff --git a/docs/contributors/design/design.md b/docs/contributors/design/README.md similarity index 100% rename from docs/contributors/design/design.md rename to docs/contributors/design/README.md diff --git a/docs/contributors/documentation/documentation.md b/docs/contributors/documentation/README.md similarity index 99% rename from docs/contributors/documentation/documentation.md rename to docs/contributors/documentation/README.md index 061ab751101476..e3033c3c8f88e9 100644 --- a/docs/contributors/documentation/documentation.md +++ b/docs/contributors/documentation/README.md @@ -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 diff --git a/docs/manifest.json b/docs/manifest.json index f93908967b9bef..c72f2673adf4b1 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -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" }, { @@ -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" }, { @@ -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" }, { diff --git a/docs/toc.json b/docs/toc.json index 9d064bd84402f3..d2c1d102340905 100644 --- a/docs/toc.json +++ b/docs/toc.json @@ -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": [] }, @@ -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": [] }, @@ -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": [] }, diff --git a/packages/components/src/CONTRIBUTING.md b/packages/components/src/CONTRIBUTING.md index 166def00030865..d5c834c90e5f86 100644 --- a/packages/components/src/CONTRIBUTING.md +++ b/packages/components/src/CONTRIBUTING.md @@ -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: @@ -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. @@ -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.