Skip to content

Commit

Permalink
Merge branch 'main' into test/overflow-menu
Browse files Browse the repository at this point in the history
  • Loading branch information
kodiakhq[bot] authored Aug 1, 2022
2 parents 5c9ba05 + 83e7dd8 commit c3e1054
Show file tree
Hide file tree
Showing 99 changed files with 9,880 additions and 9,226 deletions.
11 changes: 10 additions & 1 deletion .github/ISSUE_TEMPLATE/FEATURE_REQUEST_OR_ENHANCEMENT.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@ body:
id: justification
attributes:
label: Justification
description: 'Provide the business reasons for this request.'
description: 'Provide the business reasons for this request. Provide screenshots of what you are unable to accomplish that this enhancement would make possible.'
validations:
required: true
- type: textarea
id: metrics
attributes:
Expand All @@ -48,6 +50,13 @@ body:
description:
'Do you want this work within a specific time period? Is it related to
an upcoming release?'
- type: input
id: team
attributes:
label: Your team
description: 'Please provide the requesting team you are apart of. @mention design and development members from your team that should be aware of this request.'
validations:
required: true
- type: input
id: resources
attributes:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/dco.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
steps:
- name: "DCO Assistant"
if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have read the DCO document and I hereby sign the DCO.') || github.event_name == 'pull_request_target'
uses: cla-assistant/github-action@v2.1.3-beta
uses: cla-assistant/github-action@v2.2.0
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
PERSONAL_ACCESS_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/issue-triage.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ jobs:
name: Add issue to Design System project
runs-on: ubuntu-latest
steps:
- uses: actions/add-to-project@v0.1.0
- uses: actions/add-to-project@v0.3.0
with:
project-url: https://github.com/orgs/carbon-design-system/projects/39
github-token: ${{ secrets.ADD_TO_PROJECT_PAT }}
Binary file not shown.
Binary file not shown.
Binary file not shown.
2 changes: 1 addition & 1 deletion config/eslint-config-carbon/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "eslint-config-carbon",
"description": "ESLint configuration for Carbon",
"version": "2.13.0",
"version": "2.14.0",
"license": "Apache-2.0",
"main": "index.js",
"repository": {
Expand Down
2 changes: 1 addition & 1 deletion config/jest-config-carbon/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "jest-config-carbon",
"private": true,
"description": "Jest configuration and preset for Carbon",
"version": "1.3.0",
"version": "1.4.0",
"license": "Apache-2.0",
"main": "index.js",
"repository": {
Expand Down
96 changes: 96 additions & 0 deletions docs/experimental-code.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
# Experimental Code

The team occasionally will author code, or accept contributions, that is
considered experimental or unstable. The goal for this code is to ship it as
unstable for sponsor groups to leverage. During this time, the team can get
feedback around what is working and what does not work so that changes can be
made before an official release.

This code should be treated as experimental and will break between release
versions for the package that it is being imported from.

- The API is not fixed, and is likely to change
- The API is not bound by semver
- The component export may change, be renamed, or removed in the future without
warning

## Naming experimental code

For experimental or unstable code, we use the `unstable_` prefix. For example:

```js
// An unstable method
function unstable_layout() {
// ...
}

// An unstable variable
const unstable_meta = {
// ...
};

// An unstable component will retain its name, specifically for things like
// the rules of hooks plugin which depend on the correct casing of the name
function Pagination(props) {
// ...
}

// However, when we export the component we will export it with the `unstable_`
// prefix. (Similar to React.unstable_Suspense, React.unstable_Profiler)
export { default as unstable_Pagination } from './components/Pagination';
```

For teams using these features, they will need to import the functionality by
using the `unstable_` prefix. For example:

```jsx
import { unstable_Pagination as Pagination } from 'carbon-components-react';
```

## Experimental status

Components with the prefix `unstable_`, eg, `unstable_ComponentName` are
experimental

Within the storybook these components' stories are prefixed, and may include a
notice regarding specific instability or experimental status.

## Moving to stable

Over time it becomes apparent an experimental API has stabilized and suits the
needs of most users. When there hasn't been much movement on a component, it can
be marked to be moved from "experimental" status to be "stable" by opening a new
issue requesting it be moved to stable.

The following criteria need to be met when moving a component from experimental
to stable:

- [ ] All files have a copyright banner
- [ ] All components exported in `src/index.js` and should not be `unstable_`
prefixed
- [ ] Component has a label in the github repository
- [ ] Component should be documented on the website
- [ ] Component should have a usage, style, and code tab
- [ ] Component may have a component demo
- [ ] For each component exported:
- [ ] Component is written as a function declaration or uses `forwardRef`
- [ ] Component has `propTypes` defined
- [ ] Each prop type has a comment (used in storybook)
- [ ] Prop types are as specific as needed, prefer `PropTypes.shape` over
`PropTypes.object` if possible
- [ ] Default props are listed as default args in the function definition (not
in defaultProps)
- [ ] Note: default props should be stable, in other words props like
`onClick = () => {}` can cause re-renders since the function identity
is not stable
- [ ] Component has a story in `<ComponentName>.stories.js`
- [ ] Component has an mdx document that follows our outline
- [ ] mdx document coverages at least common use-cases and provides a prop
table
- [ ] Stories cover at least common use-cases
- [ ] Stories may include a `Playground` story for controls
- [ ] Stories should mirror intended usage of the component
- [ ] Component has unit/integration tests written in RTL for testing the
component API
- [ ] Component is tested via VRT for at least the initial render state
- [ ] Component is tested via AVT for at least the initial render state
6 changes: 4 additions & 2 deletions docs/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,8 @@ git push upstream v11.2.0
[Release Workflow](https://github.com/carbon-design-system/carbon/actions/workflows/release.yml)
- [ ] Review and approve the Pull Request generated from this action on the
[Carbon Website](https://github.com/carbon-design-system/carbon-website)
to verify no breaking changes have occurred in this release
to verify no breaking changes have occurred in this release. If the PR
from the previous release was not merged, the existing PR will be updated.

**Friday**

Expand All @@ -144,7 +145,8 @@ Friday of a sprint. To make the switch, you will need to:

### Post release

- [ ] Update the [release radar wiki page](https://github.com/carbon-design-system/carbon/wiki/Release-radar)
- [ ] Update the
[release radar wiki page](https://github.com/carbon-design-system/carbon/wiki/Release-radar)

After a release has switched packages from `next` to `latest`, it is important
to monitor channels on Slack and issues on GitHub in case breaking changes may
Expand Down
40 changes: 1 addition & 39 deletions docs/style.md
Original file line number Diff line number Diff line change
Expand Up @@ -499,45 +499,7 @@ the function as `handleOnClick`.

#### Naming experimental code

The team occasionally will author code, or accept contributions, that is
considered experimental or unstable. The goal for this code is to ship it as
unstable for sponsor groups to leverage. During this time, the team can get
feedback around what is working and what does not work so that changes can be
made before an official release.

For experimental or unstable code, we use the `unstable_` prefix. For example:

```js
// An unstable method
function unstable_layout() {
// ...
}

// An unstable variable
const unstable_meta = {
// ...
};

// An unstable component will retain its name, specifically for things like
// the rules of hooks plugin which depend on the correct casing of the name
function Pagination(props) {
// ...
}

// However, when we export the component we will export it with the `unstable_`
// prefix. (Similar to React.unstable_Suspense, React.unstable_Profiler)
export { default as unstable_Pagination } from './components/Pagination';
```

For teams using these features, they will need to import the functionality by
using the `unstable_` prefix. For example:

```jsx
import { unstable_Pagination as Pagination } from 'carbon-components-react';
```

This code should be treated as experimental and will break between release
versions for the package that it is being imported from.
See [Experimental Code](./experimental-code.md#naming-experimental-code);

### Testing

Expand Down
4 changes: 2 additions & 2 deletions examples/codesandbox-styles/package.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
{
"name": "codesandbox-styles",
"private": true,
"version": "0.10.0",
"version": "0.11.0",
"scripts": {
"develop": "vite"
},
"devDependencies": {
"vite": "^2.8.0"
},
"dependencies": {
"@carbon/styles": "^1.7.0",
"@carbon/styles": "^1.8.0",
"sass": "^1.51.0"
}
}
4 changes: 2 additions & 2 deletions examples/codesandbox-with-sass-compilation/package.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{
"name": "codesandbox-with-sass-compilation",
"version": "0.8.0",
"version": "0.9.0",
"private": true,
"dependencies": {
"@carbon/react": "^1.7.0",
"@carbon/react": "^1.8.0",
"react": "^17.0.0",
"react-dom": "^17.0.0"
},
Expand Down
4 changes: 2 additions & 2 deletions examples/codesandbox/package.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{
"name": "codesandbox",
"version": "0.8.0",
"version": "0.9.0",
"private": true,
"dependencies": {
"@carbon/react": "^1.7.0",
"@carbon/react": "^1.8.0",
"react": "^17.0.0",
"react-dom": "^17.0.0"
},
Expand Down
4 changes: 2 additions & 2 deletions examples/light-dark-mode/package.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
{
"name": "examples-light-dark",
"private": true,
"version": "0.5.0",
"version": "0.6.0",
"scripts": {
"build": "next build",
"dev": "next dev",
"lint": "next lint",
"start": "next start"
},
"dependencies": {
"@carbon/react": "^1.7.0",
"@carbon/react": "^1.8.0",
"next": "12.1.4",
"react": "18.0.0",
"react-dom": "18.0.0"
Expand Down
4 changes: 2 additions & 2 deletions examples/nextjs/package.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
{
"name": "examples-nextjs",
"private": true,
"version": "0.7.0",
"version": "0.8.0",
"scripts": {
"build": "next build",
"dev": "next dev",
"lint": "next lint",
"start": "next start"
},
"dependencies": {
"@carbon/react": "^1.7.0",
"@carbon/react": "^1.8.0",
"next": "12.1.4",
"react": "18.0.0",
"react-dom": "18.0.0"
Expand Down
4 changes: 2 additions & 2 deletions examples/vite/package.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
{
"name": "vite",
"private": true,
"version": "0.5.0",
"version": "0.6.0",
"scripts": {
"dev": "vite",
"build": "vite build",
"preview": "vite preview"
},
"dependencies": {
"@carbon/react": "^1.7.0",
"@carbon/react": "^1.8.0",
"react": "^17.0.0",
"react-dom": "^17.0.0"
},
Expand Down
6 changes: 3 additions & 3 deletions packages/carbon-components-react/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "carbon-components-react",
"description": "The Carbon Design System is IBM’s open-source design system for products and experiences.",
"version": "8.7.0",
"version": "8.8.0",
"license": "Apache-2.0",
"main": "lib/index.js",
"module": "es/index.js",
Expand Down Expand Up @@ -39,8 +39,8 @@
"sass": "^1.33.0"
},
"dependencies": {
"@carbon/react": "^1.7.0",
"@carbon/styles": "^1.7.0",
"@carbon/react": "^1.8.0",
"@carbon/styles": "^1.8.0",
"@carbon/telemetry": "0.1.0"
},
"devDependencies": {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
// Code generated by carbon-components-react. DO NOT EDIT.
//
// Copyright IBM Corp. 2018, 2018
//
// This source code is licensed under the Apache-2.0 license found in the
// LICENSE file in the root directory of this source tree.
//

@forward '@carbon/styles/scss/utilities/hide-at-breakpoint';
4 changes: 2 additions & 2 deletions packages/carbon-components/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "carbon-components",
"description": "The Carbon Design System is IBM’s open-source design system for products and experiences.",
"version": "11.7.0",
"version": "11.8.0",
"license": "Apache-2.0",
"repository": {
"type": "git",
Expand Down Expand Up @@ -40,7 +40,7 @@
"sass": "^1.33.0"
},
"dependencies": {
"@carbon/styles": "^1.7.0",
"@carbon/styles": "^1.8.0",
"@carbon/telemetry": "0.1.0"
},
"devDependencies": {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
// Code generated by carbon-components. DO NOT EDIT.
//
// Copyright IBM Corp. 2018, 2018
//
// This source code is licensed under the Apache-2.0 license found in the
// LICENSE file in the root directory of this source tree.
//

@forward '@carbon/styles/scss/utilities/hide-at-breakpoint';
2 changes: 1 addition & 1 deletion packages/cli/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
"@babel/core": "^7.18.2",
"@carbon/cli-reporter": "^10.5.0",
"@octokit/plugin-retry": "^3.0.7",
"@octokit/plugin-throttling": "^2.6.0",
"@octokit/plugin-throttling": "^4.0.0",
"@octokit/rest": "^16.28.1",
"@rollup/plugin-babel": "^5.3.0",
"@rollup/plugin-commonjs": "^21.0.0",
Expand Down
Loading

0 comments on commit c3e1054

Please sign in to comment.