Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Definition of done #4273

Merged
merged 22 commits into from
Oct 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions src/data/nav-items.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,9 @@
- title: Contributing
pages:
- title: Get started
path: /contributing/get-started/
- title: Code
path: /contributing/code/
- title: Design
path: /contributing/design/
path: /contributing/get-started/overview
- title: Component checklist
path: /contributing/component-checklist/
- title: Documentation
path: /contributing/documentation/
- title: Migrating
Expand Down
159 changes: 159 additions & 0 deletions src/pages/contributing/component-checklist/index.mdx

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
title: Code
title: Getting started
description:
Code contributions can include anything from squashing bugs to adding feature
requests. Check out the instructions below to contribute code effectively.
tabs: ['Overview', 'Code', 'Design']
---

export const Title = () => <span>Contribute code</span>;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
title: Design
title: Getting started
description:
Design contributions can involve anything from creating design specs for
feature requests to maintaining Figma libraries. Below you'll find tips and
best practices to get started.
tabs: ['Overview', 'Code', 'Design']
---

export const Title = () => <span>Contribute design</span>;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
title: Get started
title: Getting 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!
Design contributions can involve anything from creating design specs for
feature requests to maintaining Figma libraries. Below you'll find tips and
best practices to get started.
tabs: ['Overview', 'Code', 'Design']
---

<PageDescription>
Expand Down Expand Up @@ -192,6 +193,15 @@ solutions and then creating a design spec for developers.
[Here are issues](https://github.com/carbon-design-system/carbon/issues?q=is%3Aopen+is%3Aissue+label%3A%22needs%3A+community+contribution%22+)
in our enhancement backlog that need design or development work.

### New components

New components are a large multidiscipline contribution and must be contributed
in phases to insure quality and business value. To propose a net new component,
follow the [phased contribution process](/contributing/contribution-process) and
complete all requirements in the
[component checklist](contributing/component-checklist). All requirement
categories must be completed before a component can be considered done.

### Design kits

This work is all about creating and updating reusable components in Figma.
Expand Down Expand Up @@ -226,8 +236,14 @@ 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:
Whether you’re contributing code, designs, or documentation, there’s a process
to follow.  For larger contributions like new components or patterns a more
rigorous process must be followed to insure production level quality and
business value. We have laid out the phases and criteria on the next page in
[contribution process](contributing/contribution-process).

For smaller contributions like small additions, enhancements, or bug fixes
follow the process below.

### 1. Find a project to work on

Expand Down Expand Up @@ -262,7 +278,7 @@ 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
### 3. Submit for review

#### Code deliverables

Expand Down
16 changes: 16 additions & 0 deletions src/styles/_component-checklist.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
//---------------------------------------
// Contributing / Component checklist
//---------------------------------------

// custom table styles
// align to grid
.table--component-checklist .page-table {
th:first-child {
// 2 columns
width: 15.4%;
}
th:nth-child(2) {
// 5 columns
width: 43%;
}
}
1 change: 1 addition & 0 deletions src/styles/index.scss
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
@import 'structured-list';
@import 'plex-serif';
@import 'meetups';
@import 'component-checklist';
@import 'overrides';
@import 'src/components/ColorBlock/color-block.scss';
@import 'src/components/ColorGrid/color-grid.scss';
Expand Down
Loading