-
Notifications
You must be signed in to change notification settings - Fork 793
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: contributing code and design new content (#3757)
* update: add code and design pages * add: screencapture videos * add videos and still images * edit: typos * Update src/pages/contributing/code.mdx Co-authored-by: Lauren Rice <[email protected]> * Update src/pages/contributing/design.mdx Co-authored-by: Lauren Rice <[email protected]> * Update src/pages/contributing/design.mdx Co-authored-by: Lauren Rice <[email protected]> * Update src/pages/contributing/design.mdx Co-authored-by: Lauren Rice <[email protected]> * fix: typos * add: video boarder and title prop * Reviewer feedback --------- Co-authored-by: Lauren Rice <[email protected]>
- Loading branch information
1 parent
19f2fde
commit 175ba94
Showing
21 changed files
with
224 additions
and
1,889 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,110 @@ | ||
--- | ||
title: Code | ||
description: | ||
Code contributions can include anything from squashing bugs to adding feature | ||
requests. Check out the instructions below to contribute code effectively. | ||
--- | ||
|
||
export const Title = () => <span>Contribute code</span>; | ||
|
||
<PageDescription> | ||
|
||
Code contributions can include anything from squashing bugs to adding feature | ||
requests. Check out the instructions below to contribute code effectively. | ||
|
||
</PageDescription> | ||
|
||
<AnchorLinks> | ||
|
||
<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: Get feedback</AnchorLink> | ||
|
||
</AnchorLinks> | ||
|
||
## 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 | ||
roadmap, is open for community contribution. | ||
|
||
#### 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%22needs%3A+community+contribution%22+) | ||
labeled with `needs: community contribution`. Any issue labeled with | ||
`needs: code contribution` is fair game! Put a comment in the issue saying you'd | ||
like to help. | ||
|
||
<Video | ||
src="/videos/code-contribution.mp4" | ||
poster="/videos/code-contribution.png" | ||
> | ||
<track default srcLang="en" title="Volunteer for existing work" /> | ||
</Video> | ||
|
||
If you want to join an issue that is already assigned to someone or has a | ||
specific milestone, please discuss with the assignee of the issue or with the | ||
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 [Carbon Developer office hours](/whats-happening/meetups/) or | ||
[contact us](/help/contact-us/) directly. | ||
|
||
#### Submit an idea or bug report | ||
|
||
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 us know in your | ||
issue! Your idea will then go through a triage process by the Carbon team. | ||
|
||
## 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 | ||
request. You can explore all the repositories in the Carbon Design system | ||
[here](https://github.com/carbon-design-system), but you will likely be working | ||
in one of the following: | ||
|
||
- [Carbon website](https://github.com/carbon-design-system/carbon-website/) | ||
- [Carbon monorepo](https://github.com/carbon-design-system/carbon) | ||
- [Carbon Angular](https://github.com/IBM/carbon-components-angular/) | ||
- [Carbon Vue](https://github.com/carbon-design-system/carbon-components-vue/) | ||
- [Carbon charts](https://github.com/carbon-design-system/carbon-charts/) | ||
|
||
If you need help troubleshooting, [reach out](/help/contact-us/) to the Carbon | ||
team. | ||
|
||
## Step 3: Refine the issue | ||
|
||
Your dev environment is set up and you might be tempted to jump into coding. | ||
Before you get started, we recommend you refine the issue by creating a rough | ||
task list and posting it in the issue comments. | ||
|
||
If you have trouble answering any of these questions, reach out to the Carbon | ||
team and we will help you refine your issue: | ||
|
||
- Am I clear on the scope of this work? | ||
- Is this task list feasible for me to do? | ||
- Should a designer get involved to do initial research or create a design spec? | ||
- Do I need to collaborate with anyone else? | ||
|
||
## 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 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 | ||
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. |
Binary file removed
BIN
-19.5 KB
src/pages/contributing/component/images/content-switcher-style-1.png
Binary file not shown.
Binary file removed
BIN
-111 KB
src/pages/contributing/component/images/contribution-iconography-pictogram.png
Binary file not shown.
Binary file not shown.
Oops, something went wrong.
175ba94
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Successfully deployed to the following URLs:
carbondesignsystem – ./
carbondesignsystem-carbon-design-system.vercel.app
carbondesignsystem-git-main-carbon-design-system.vercel.app
carbondesignsystem.vercel.app