Skip to content

Commit

Permalink
Reviewer feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
aubrey-oneal committed Oct 6, 2023
1 parent 7b60787 commit f44a337
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 22 deletions.
20 changes: 10 additions & 10 deletions src/pages/contributing/code.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,14 @@ requests. Check out the instructions below to contribute code effectively.

<AnchorLinks>

<AnchorLink>Step 1: Find a project to work on</AnchorLink>
<AnchorLink>Step 2: Set up your developer environment</AnchorLink>
<AnchorLink>Step 1: Find a project</AnchorLink>
<AnchorLink>Step 2: Set up your environment</AnchorLink>
<AnchorLink>Step 3: Refine the issue</AnchorLink>
<AnchorLink>Step 4: Iterate and get feedback</AnchorLink>
<AnchorLink>Step 4: Get feedback</AnchorLink>

</AnchorLinks>

## 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
Expand All @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down
24 changes: 12 additions & 12 deletions src/pages/contributing/design.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ practices to get started.

<AnchorLinks>

<AnchorLink>Step 1: Find a project to work on</AnchorLink>
<AnchorLink>Step 1: Find a project</AnchorLink>
<AnchorLink>Step 2: Refine the issue</AnchorLink>
<AnchorLink>Step 3: Iterate and get feedback</AnchorLink>
<AnchorLink>Step 3: Get feedback</AnchorLink>

</AnchorLinks>

## 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
Expand Down Expand Up @@ -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

Expand All @@ -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.

0 comments on commit f44a337

Please sign in to comment.