From f44a33797066b8400785028802b722d6fb4feb6f Mon Sep 17 00:00:00 2001 From: Aubrey O'Neal Date: Fri, 6 Oct 2023 10:31:08 -0500 Subject: [PATCH] Reviewer feedback --- src/pages/contributing/code.mdx | 20 ++++++++++---------- src/pages/contributing/design.mdx | 24 ++++++++++++------------ 2 files changed, 22 insertions(+), 22 deletions(-) diff --git a/src/pages/contributing/code.mdx b/src/pages/contributing/code.mdx index 77d1094b338..ac2adb7622b 100644 --- a/src/pages/contributing/code.mdx +++ b/src/pages/contributing/code.mdx @@ -16,14 +16,14 @@ requests. Check out the instructions below to contribute code effectively. -Step 1: Find a project to work on -Step 2: Set up your developer environment +Step 1: Find a project +Step 2: Set up your environment Step 3: Refine the issue -Step 4: Iterate and get feedback +Step 4: Get feedback -## Step 1: Find a project to work on +## Step 1: Find a project New issues submitted by the community are initially triaged by Carbon team members. Any issue that the Carbon team accepts, but can not fit in their @@ -50,7 +50,7 @@ Carbon team to coordinate. Issues labeled `good first issue` are great candidates to pick up if you are in the code for the first time. The Carbon team is also happy to help you. Just -stop by our [office hours](/whats-happening/meetups/) or +stop by our [Carbon Developer office hours](/whats-happening/meetups/) or [contact us](/help/contact-us/) directly. #### Submit an idea or bug report @@ -63,7 +63,7 @@ sure it is a novel idea or bug. Then, file your proposal on GitHub using the If you're willing to work on this idea yourself, be sure to let us know in your issue! Your idea will then go through a triage process by the Carbon team. -## Step 2: Set up your developer environment +## Step 2: Set up your environment [Follow these steps](https://github.com/carbon-design-system/carbon/blob/main/.github/CONTRIBUTING.md) to install the tools, set up your environment, and learn how to make a pull @@ -94,13 +94,13 @@ team and we will help you refine your issue: - Should a designer get involved to do initial research or create a design spec? - Do I need to collaborate with anyone else? -## Step 4: Iterate and get feedback +## Step 4: Get feedback Most contributors work in groups of 2-3 and either set up weekly sessions or join [meetups](/whats-happening/meetups/#carbon-office-hours) such as the Data -Viz Guild or office hours. In these sessions, it is common to share work in -progress and ask lots of questions. As you make progress, update your GitHub -issue. +Viz Guild or Carbon Developer office hours. In these sessions, it is common to +share work in progress and ask lots of questions. As you make progress, update +your GitHub issue. Work that results in code will be reviewed directly in a pull request. Maintainers will be reviewing your work and making comments, asking questions diff --git a/src/pages/contributing/design.mdx b/src/pages/contributing/design.mdx index d4fa6fb0a51..c5c975a10a4 100644 --- a/src/pages/contributing/design.mdx +++ b/src/pages/contributing/design.mdx @@ -18,13 +18,13 @@ practices to get started. -Step 1: Find a project to work on +Step 1: Find a project Step 2: Refine the issue -Step 3: Iterate and get feedback +Step 3: Get feedback -## Step 1: Find a project to work on +## Step 1: Find a project New issues submitted by the community are initially triaged by Carbon team members. Any issue that the Carbon team accepts, but can not fit in their @@ -59,8 +59,8 @@ Figma. This work is not currently tracked in GitHub, so check out the and get involved by reaching out to the contacts listed. The Carbon team is also happy to help you. Just stop by our -[office hours](/whats-happening/meetups/) or [contact us](/help/contact-us/) -directly. +[Carbon Design office hours](/whats-happening/meetups/) or +[contact us](/help/contact-us/) directly. #### Submit an idea @@ -78,19 +78,19 @@ Whereas code contributions tend to be well defined, design contributions can be a little more ambiguous. We recommend you try writing a rough task list of what you believe your contribution will entail, and post it in the GitHub issue comments. In most cases, we recommend you then reach out to the Carbon team or -come to office hours. We'll help you further refine your issue, clarify the -scope of work, and connect you to other collaborators. Some good questions to -ask yourself are: +come to Carbon Design office hours. We'll help you further refine your issue, +clarify the scope of work, and connect you to other collaborators. Some good +questions to ask yourself are: - Am I clear on the scope of this work? - Is this task list feasible for me to do? - Do I need to collaborate with anyone else? - Do I have a clear definition of done or a plan to pass this to a developer? -## Step 3: Iterate and get feedback +## Step 3: Get feedback Most contributors work in groups of 2-3 and either set up weekly sessions or join [meetups](/whats-happening/meetups/#carbon-office-hours) such as the Data -Viz Guild or office hours. In these sessions, it is common to share work in -progress and ask lots of questions. In return, you'll get candid feedback and -help. As you make progress, update your GitHub issue. +Viz Guild or Carbon Design office hours. In these sessions, it is common to +share work in progress and ask lots of questions. In return, you'll get candid +feedback and help. As you make progress, update your GitHub issue.