diff --git a/conf.d/rewrite.conf b/conf.d/rewrite.conf index 18301cc0b11..431ca8c864b 100644 --- a/conf.d/rewrite.conf +++ b/conf.d/rewrite.conf @@ -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; diff --git a/src/data/nav-items.yaml b/src/data/nav-items.yaml index 9ea3c9d6fee..bbc46488a58 100644 --- a/src/data/nav-items.yaml +++ b/src/data/nav-items.yaml @@ -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 diff --git a/src/pages/contributing/get-started.mdx b/src/pages/contributing/get-started.mdx new file mode 100644 index 00000000000..efff44cb333 --- /dev/null +++ b/src/pages/contributing/get-started.mdx @@ -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! +--- + + + +The Carbon Design System is made possible through a vibrant community of +designers and developers. Anyone can contribute code, design, and documentation. + + + + + +Get started +Contribution gallery +Carbon champions +Types of contribution +The process + + + +## 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. + + + +## 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. diff --git a/src/pages/contributing/overview.mdx b/src/pages/contributing/overview.mdx deleted file mode 100644 index 79852db8be7..00000000000 --- a/src/pages/contributing/overview.mdx +++ /dev/null @@ -1,108 +0,0 @@ ---- -title: Overview -description: - Interested in contributing to Carbon? This design system is the result of - community contributions, large and small--of code, design, ideas, and - guidance. Here's how you can contribute too. ---- - - - -Interested in contributing to Carbon? This design system is the result of -community contributions, large and small--of code, design, ideas, and guidance. -Here's how you can contribute too. - - - - - -Introduction -Working in the open -The Carbon community -Project workflow -Contributor License Agreement - - - -## Introduction - -Carbon is free to use for anybody building a product or website, and the Carbon -community is always working to make it better. Contributors like you help to -make Carbon great, and so we're glad you're here. - -Contributions are not limited to code. We also encourage feedback, -documentation, new designs, and tools. - -All you need is a [public GitHub account](https://github.com/join) to get -started. Most contributions begin with a GitHub issue using one of these -templates: - -- [Ask a question](https://github.com/carbon-design-system/carbon/issues/new?assignees=&labels=type%3A+question+%3Aquestion%3A&template=question.md&title=) -- [Report a bug](https://github.com/carbon-design-system/carbon/issues/new?assignees=&labels=type%3A+bug+%F0%9F%90%9B&template=bug-report.md&title=) -- [Request a feature](https://github.com/carbon-design-system/carbon/issues/new?assignees=&labels=type%3A+enhancement+%F0%9F%92%A1&template=feature-request-or-enhancement.md&title=) - -## Working in the open - -Carbon lives on GitHub. All work, discussion, issues, bugs, features, -improvements, and comments happen right out in the open where everyone can see. -As we mentioned, you'll need a [public GitHub account](https://github.com/join) -to contribute. - -If you're looking for something that we don't have, or you notice something -could be improved, you have two options: - -1. **Open an issue for the request.** We'll review the issue and get back to you - with next steps. If we decide the request should be part of our pipeline, - we'll add it to our roadmap. There are never timeline guarantees for - requests, but we'll do our best to give you an estimate. - -2. **Begin the work yourself and contribute it back to Carbon.** We appreciate - complete contributions but also works in progress. You're welcome to open an - issue to surface your work and we'll weigh in and help where we can. - -Regardless of how you choose to contribute, we encourage you to open an issue as -early as possible in the process. - -If working with GitHub sounds like a lot, check out -[this free video series](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github). -It's one of our favorite resources. - -## The Carbon community - -### Users - -Users are members of the community who use Carbon guidelines, assets, and -tooling. Anyone can be a user, and we encourage users to participate in the -community as much as possible. - -### Contributors - -Contributors are members of the community who contribute to Carbon in a material -way. Anyone can be a contributor. In addition to participating as a user, you -can also contribute by: - -- Reporting bugs or missing features through GitHub issues -- Fixing bugs, adding features, and improving documentation - -### Maintainers - -Maintainers are members of the community who are committed to the success of -individual Carbon projects. In addition to their participation as a contributor, -maintainers: - -- Label, close, and manage GitHub issues -- Close and merge GitHub pull requests - -## Project workflow - -Carbon Design System projects typically use a -[fork and pull request workflow](https://guides.github.com/activities/forking/) -for contributions. Specific instructions can be found in each project’s GitHub -`CONTRIBUTING.md` file. - -## Contributor License Agreement - -The Carbon core team works for IBM. To accept contributions, we need a signed -Contributor License Agreement (CLA) from you before code contributions can be -reviewed and merged. If you have questions, please don't hesitate -to [reach out](/help/contact-us).