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

Reshaping Contributing docs #67785

Open
wants to merge 14 commits into
base: trunk
Choose a base branch
from
Open

Reshaping Contributing docs #67785

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
390410a
Reshaping Contribution docs
juanbuis Dec 10, 2024
6be51d6
Removing internal links + references
juanbuis Dec 10, 2024
fbc71cc
Removing references
juanbuis Dec 10, 2024
29e18ec
Update storybook/stories/contributing/contributing-components.txt
juanbuis Dec 11, 2024
29effbe
Update storybook/stories/contributing/contributing-components.txt
juanbuis Dec 11, 2024
5e1f238
Tiny copy change
juanbuis Dec 11, 2024
7e26bb5
Merge branch 'trunk' of https://github.com/juanbuis/gutenberg into trunk
juanbuis Dec 11, 2024
7b09e72
Apply copy suggestions
juanbuis Dec 11, 2024
847a7d2
Small copy changes
juanbuis Dec 11, 2024
05f2f75
Update contributing-components.txt
juanbuis Dec 11, 2024
54006bf
Update storybook/stories/contributing/contributing-overview.txt
juanbuis Dec 19, 2024
01d1682
Update storybook/stories/contributing/contributing-components.txt
juanbuis Dec 19, 2024
6df6c52
Update contributing-components.txt
juanbuis Dec 19, 2024
d80d386
Merge branch 'trunk' of https://github.com/juanbuis/gutenberg into trunk
juanbuis Dec 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Removing internal links + references
  • Loading branch information
@juanbuis
juanbuis committed Dec 10, 2024
commit 6be51d67c30dd7ad4967230a8a0751be34f22df2
4 changes: 2 additions & 2 deletions storybook/stories/contributing/contributing-components.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Step 5: [Publish and Maintain](#step-5)

It’s important to ask yourself this question before starting your contribution. Our library should include components that are generic and flexible enough to work across various products. It should include what’s shared across products and leave out what’s not.

A great first step is to share your idea with our design community to see if there’s a need for your component. You can leave a comment in the [Design Systems Figma Library](https://www.figma.com/design/ficiK5ADsOuiCromUZam1E/WordPress-Design-System-(Community)?node-id=13482-72792&t=ofEJnkdwKdS5mhGX-1), or [drop a question in #design-systems on Slack](https://a8c.slack.com/archives/CNGQYA3B9), where people will be happy to help.
A great first step is to share your idea with our design community to see if there’s a need for your component. You can leave a comment in the [Design Systems Figma Library](https://www.figma.com/design/ficiK5ADsOuiCromUZam1E/WordPress-Design-System-(Community)?node-id=13482-72792&t=ofEJnkdwKdS5mhGX-1), or drop a question in #design-systems on Slack, where people will be happy to help.
juanbuis marked this conversation as resolved.
Show resolved Hide resolved

Some more questions you can ask yourself if you’re thinking of creating a new component:

Expand Down Expand Up @@ -148,7 +148,7 @@ Once your component has been fully refined, tested, and approved, it’s time to
After all feedback is addressed and approvals are in place, merge your pull request. Your component is now part of the WordPress Design System.

**Communicate Changes**
If you’ve introduced significant features, fixed critical issues, or made changes that might affect other contributors, consider posting in `#design-systems` on Slack or writing a dev note. This keeps the community informed and helps maintain ecosystem stability.
If you’ve introduced significant features, fixed critical issues, or made changes that might affect other contributors, consider posting in #design-systems on Slack or writing a dev note. This keeps the community informed and helps maintain ecosystem stability.

**Ongoing Maintenance**
Components aren’t “set and forget.” Over time, standards, accessibility requirements, and design patterns may evolve. Stay open to feedback and consider revisiting your component periodically to ensure it still meets current needs without introducing breaking changes.
Expand Down
2 changes: 1 addition & 1 deletion storybook/stories/contributing/contributing-documentation.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Follow the following steps to fork and clone the Gutenberg repository, and creat

When your PR is live, you can link it to your issue by selecting it in the sidebar under ‘development’. This makes it easy to keep track of both simultaneously.

If you need help with this part, feel free to reach out to us in [\#design-systems on Slack](https://a8c.slack.com/archives/CNGQYA3B9), where we’ll be happy to help you get your PR live.
If you need help with this part, feel free to reach out to us in #design-systems on Slack, where we’ll be happy to help you get your PR live.

**Step 4: Work towards merging your pull request**

Expand Down
6 changes: 3 additions & 3 deletions storybook/stories/contributing/contributing-get-ready.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { Meta } from '@storybook/addon-docs';

Ready to start contributing to WPDS? There are a couple of steps you’ll need to take to get set up — we’ll take you through them.
juanbuis marked this conversation as resolved.
Show resolved Hide resolved

We understand GitHub might seem complicated if you’ve never used it before. Don’t worry — we’re happy to help you out with any questions in [\#design-systems on Slack](https://a8c.slack.com/archives/CNGQYA3B9).
We understand GitHub might seem complicated if you’ve never used it before. Don’t worry — we’re happy to help you out with any questions in #design-systems on Slack.

[Step 1: Get GitHub access](#step-1:-get-github-access)
[Step 2: Link your GitHub and WP.org accounts](#step-2:-link-your-github-and-wp.org-accounts)
Expand All @@ -25,7 +25,7 @@ Then, you’ll need to connect your GitHub and WordPress.org accounts to make su

#### **Step 3: Learn about the contribution process** {#step-3:-learn-about-the-contribution-process}

In order to make effective contributions to WPDS, it’s important to know the basics of our contribution process. While we’ll take you through a step-by-step process depending on your contribution, we’ll explain the basics below.
In order to make effective contributions to WPDS, it’s important to know the basics of our contribution process. While we’ll take you through a step-by-step process depending on your contribution, we’ll explain the basics below.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
In order to make effective contributions to WPDS, it’s important to know the basics of our contribution process. While we’ll take you through a step-by-step process depending on your contribution, we’ll explain the basics below.
In order to make effective contributions to WPDS, it’s important to know the basics of the contribution process. There's a step-by-step process for different kinds of contributions and a few common basics you can find below.

I don't know if my wording if the best but I'm basing it on the copy guidelines and GitHub commenting etiquette.


Depending on the contribution you’re making to the design system, you’ll either need to create an issue, or both an issue and a pull request (PR).

Expand Down Expand Up @@ -58,7 +58,7 @@ When you’re ready to share what you’ve been working on, you can add a PR to

Creating a PR takes a couple of steps that involve copying the Gutenberg repository to your device.

You can find a step-by-step explanation [on this page](https://developer.wordpress.org/block-editor/contributors/code/git-workflow/#git-workflow-walkthrough). If you’re running into any issues, let us know in [\#design-systems on Slack](https://a8c.slack.com/archives/CNGQYA3B9).
You can find a step-by-step explanation [on this page](https://developer.wordpress.org/block-editor/contributors/code/git-workflow/#git-workflow-walkthrough). If you’re running into any issues, let us know in #design-systems on Slack.

The full process is as follows:

Expand Down
5 changes: 2 additions & 3 deletions storybook/stories/contributing/contributing-overview.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,12 @@ A design system is never finished. That’s why we invite all designers, develop

### **Get connected**

In order to stay up to date on all things design systems at Automattic, [join the \#design-systems channel on Slack](https://a8c.slack.com/archives/CNGQYA3B9).

In order to stay up to date on all things design systems at WordPress, join the #design-systems channel on Slack.
It’s a great place to ask what could be your first contribution, and we’ll be happy to help you make it happen.

Also feel free to ask questions, join discussions, or just read along.

For anything specific to the code implementation of UI components (and the @wordpress/components package), [join the \#components channel](https://a8c.slack.com/archives/CK1QYS6P6).
For anything specific to the code implementation of UI components (and the @wordpress/components package), join the #components channel.

### **Get ready to contribute**

Expand Down
Loading