Skip to content

Commit

Permalink
docs: contributing get started new content (#3744)
Browse files Browse the repository at this point in the history
* docs: contributing get started new content

* Add Airtable iframe

* fix: typo

* update: fix typos

* fix: typos

* update: delete Carbon champion names
  • Loading branch information
aubrey-oneal authored Sep 21, 2023
1 parent 78ba8b6 commit 713d2e5
Show file tree
Hide file tree
Showing 4 changed files with 168 additions and 110 deletions.
1 change: 1 addition & 0 deletions conf.d/rewrite.conf
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ rewrite /get-started/design/(.*) /designing/get-started/kits/\$1 permanent;

# Contributions rewrites
rewrite /how-to-contribute/(.*) /contributing/\$1 permanent;
rewrite /contributing/overview /contributing/get-started permanent;

# What's happening
rewrite /updates/whats-new /whats-happening/releases permanent;
Expand Down
4 changes: 2 additions & 2 deletions src/data/nav-items.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@
path: /developing/vue-tutorial/overview/
- title: Contributing
pages:
- title: Overview
path: /contributing/overview/
- title: Get started
path: /contributing/get-started/
- title: Bugs and requests
path: /contributing/bugs-and-requests/
- title: Documentation
Expand Down
165 changes: 165 additions & 0 deletions src/pages/contributing/get-started.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,165 @@
---
title: Get started
description:
The Carbon Design System is made possible through a vibrant community of
designers and developers. Anyone can contribute code, design, documentation,
and ideas. Here's how you can contribute, too!
---

<PageDescription>

The Carbon Design System is made possible through a vibrant community of
designers and developers. Anyone can contribute code, design, and documentation.

</PageDescription>

<AnchorLinks>

<AnchorLink>Get started</AnchorLink>
<AnchorLink>Contribution gallery</AnchorLink>
<AnchorLink>Carbon champions</AnchorLink>
<AnchorLink>Types of contribution</AnchorLink>
<AnchorLink>The process</AnchorLink>

</AnchorLinks>

## Get started

If you're interested in getting involved but don't know where to start, welcome!
Designers and developers like you help to make Carbon great, and we're so glad
you're here.

To get started, subscribe to our [office hours](/whats-happening/meetups/) and
stop on by. We'll help you find an appropriate first contribution depending on
your skills and interests. Read on to learn about common types of contributions
and the process.

## Contribution gallery

In the past year, Carbon contributors have added features to components,
improved the React testing suite, created image production guidelines in Figma,
and so much more! Explore the gallery below to see a small sample of finished
projects.

<iframe
class="airtable-embed"
src="https://airtable.com/embed/appuREd5slHj4VLfl/shrv9yRexbUjzn4pJ?backgroundColor=cyanDusty&viewControls=on"
frameborder="0"
onmousewheel=""
width="100%"
height="533"
style="background: transparent; border: 1px solid #ccc;"
></iframe>

## Carbon champions

Many thanks to our 2023 Carbon champions. Know someone who deserves recognition?
Fill out the
[nomination form](https://airtable.com/appOVMXJWJgb6dwhX/shrkMzlvQhPBB6UnX).

## Types of contribution

There are several ways you can contribute, depending on your interest and
bandwidth.

### Component enhancements

This work involves enhancing our components in code, like adding new features or
variants. Designers are often responsible for researching UX and visual
solutions and then creating a design spec for developers.
[Here are issues](https://github.com/carbon-design-system/carbon/issues?q=is%3Aissue+is%3Aopen+label%3A%22proposal%3A+accepted%22+label%3A%22community+contribution%22+label%3A%22type%3A+enhancement+%F0%9F%92%A1%22+)
in our enhancement backlog that need design or development work.

### Design kits

This work is all about creating and updating reusable components is Figma.
You'll get valuable Figma experience and will collaborate with the Figma Guild.
Check out the
[status of design kits](https://www.figma.com/file/CFMtqV5Nztdbm0mi2UiDLg/Library-%2B-Template-Planning?type=design&node-id=3713-26762&mode=design&t=HqvAYXUeccKNMstT-0)
and get involved by reaching out to the contacts listed.

### Website documentation

All components and patterns require usage, style, code, and accessibility
guidance on the Carbon website. You can learn how to contribute documentation
smoothly and utilize our markdown templates on the
[documentation](/contributing/documentation/) page. A list of components that
still need documentation help can be found
[here](https://github.com/carbon-design-system/carbon-website/issues/2085).

### Fixing issues and bugs

If you find a bug in the source code, you can help us by
[filling out a bug report](https://github.com/carbon-design-system/carbon/issues/new/choose)
and, ideally, submitting a pull request with a fix.

### Icons and pictograms

You can find instructions on how to create and contribute
[UI icons](https://www.ibm.com/design/language/iconography/ui-icons/contribute),
[app icons](https://www.ibm.com/design/language/iconography/app-icons/production),
and
[pictograms](https://www.ibm.com/design/language/iconography/pictograms/contribute)
on the IBM Design Language site.

## The process

Whether you're contributing code, designs, or documentation, there's a process
to follow. Here's what it looks like:

### 1. Find a project to work on

#### Volunteer for existing work

The best way to volunteer is to look through
[existing GitHub issues](https://github.com/carbon-design-system/carbon/issues?q=is%3Aopen+is%3Aissue+label%3A%22community+contribution%22)
labeled with `community contribution`. You can also filter by
[developer](https://github.com/carbon-design-system/carbon/issues?q=is%3Aopen+is%3Aissue+label%3A%22community+contribution%22++label%3A%22role%3A+dev+%F0%9F%A4%96%22_)
or
[designer](https://github.com/carbon-design-system/carbon/issues?q=is%3Aopen+is%3Aissue+label%3A%22community+contribution%22++label%3A%22role%3A+design+%3Apencil2%3A%22+)
roles. Put a comment in the issue saying you'd like to help.

The Carbon team is also happy to help you find a good first issue. Just stop by
our [office hours](/whats-happening/meetups/) or send us a slack message.

#### Submit an idea

Have a new idea that you think would benefit Carbon? Or do you need to report a
bug? First, be sure to look through the
[issue backlog](https://github.com/carbon-design-system/carbon/issues) to make
sure it is a novel idea or bug. Then, file your proposal on GitHub using the
[issue templates](https://github.com/carbon-design-system/carbon/issues/new/choose).
If you're willing to work on this idea yourself, be sure to let is know in your
issue! Your idea will then go through a triage process by the Carbon team.

### 2. Iterate and 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 Figma
Guild, 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.

### 3. Review and publish

#### Code deliverables

Work that results in code will be reviewed directly in a pull request.
Maintainers will be reviewing your work and making comments, asking questions
and suggesting changes to be made before they merge your code. When you need to
make a change, commit and push to your branch normally. Once all revisions to
your pull request are complete, a maintainer will squash and merge your commits
for you.

#### Contributor License Agreement

The Carbon core team is part of IBM. To accept contributions, we need a signed
Contributor License Agreement (CLA) from you before code contributions can be
reviewed and merged. You will be prompted to do this in your PR, but if you have
questions, please don't hesitate
to [reach out](/help/contact-us/#slack-channels).

#### Design deliverables

For work that does not have a code deliverable, such as revisions to Figma
libraries, ask the Carbon team how to finish your contribution.
108 changes: 0 additions & 108 deletions src/pages/contributing/overview.mdx

This file was deleted.

1 comment on commit 713d2e5

@vercel
Copy link

@vercel vercel bot commented on 713d2e5 Sep 21, 2023

Choose a reason for hiding this comment

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

Please sign in to comment.