Skip to content

Commit

Permalink
Merge branch 'main' into menu-refactor
Browse files Browse the repository at this point in the history
  • Loading branch information
janhassel authored Feb 21, 2023
2 parents d5e2c60 + 1cf8fa7 commit 4455201
Show file tree
Hide file tree
Showing 28 changed files with 457 additions and 477 deletions.
43 changes: 29 additions & 14 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ contributing environment. Please take a look at our
Before contributing to Carbon, you should make sure you have the following tools
installed:

- [Node.js](https://nodejs.org/en/download/) v16 or above here or follow their
- [Node.js](https://nodejs.org/en/download/) v18 or above here or follow their
installation through a package manager
[here](https://nodejs.org/en/download/package-manager/))
- If you're on macOS, we recommend using
Expand All @@ -44,6 +44,8 @@ With that all in place, you're ready to start contributing to Carbon!

## Start contributing

## - Setting up your environment -

### 1. Fork the repo:

Go to
Expand Down Expand Up @@ -93,7 +95,28 @@ upstream [email protected]:carbon-design-system/carbon.git (fetch)
upstream [email protected]:carbon-design-system/carbon.git (push)
```

### 4. Work in a branch
Great job on getting to this point! Now it's time to code :computer:

## - Setting up your code -

### 1. Find or create an issue

Before you start coding, if you have an issue in mind that you'd like to tackle,
please first [search](https://github.com/IBM/carbon-components/issues) the
issues to see if a similar issue you'd like to work on has already been
submitted. If a similar issue has been submitted, assign yourself or ask to be
assigned to the issue by posting a comment.

If the issue does not exist, please make a new issue. Issues give us context
about what you are contributing and expedite the process to getting your
contributions merged into Carbon. It's a win for everybody :tada:

If you have no idea what you'd like to contribute, take a look at our backlog of
issues and take your pick! Our issues with the label
[`good first issue`](https://github.com/carbon-design-system/carbon/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue+%F0%9F%91%8B%22)
are a great starting point. 👋

### 2. Work in a branch

When contributing to Carbon, your work should always be done in a branch off of
your repo, this is also how you will submit your pull request when your work is
Expand All @@ -107,7 +130,7 @@ git pull origin main
git checkout -b {your-branch-name}
```

### 5. Build and start the development server
### 3. Build and start the development server

From the root directory of your fork, run:

Expand Down Expand Up @@ -144,7 +167,7 @@ For information about our coding style, such as how we name our classes and our
file structure, go to our
[developer handbook](https://github.com/carbon-design-system/carbon/blob/main/docs/developer-handbook.md#coding-style)

### 6. Test your JavaScript code
### 4. Test your JavaScript code

If you're contributing to our JavaScript code, test your changes by running our
test commands:
Expand All @@ -156,7 +179,7 @@ yarn test
For more extensive testing information, see our
[developer handbook](https://github.com/carbon-design-system/carbon/blob/main/docs/developer-handbook.md#common-tasks)

### 7. Add yourself to the contributor list
### 5. Add yourself to the contributor list

We want to make sure everyone is recognized for their contributions to Carbon!
To add yourself to the `all-contributors` table in the README, you'll need to
Expand All @@ -175,15 +198,7 @@ Then, you'll need to generate the updated `all-contributors` table by running
yarn all-contributors generate
```

### 8. Make a pull request

**Note:** Before you make a pull request,
[search](https://github.com/IBM/carbon-components/issues) the issues to see if a
similar issue has already been submitted. If a similar issue has been submitted,
assign yourself or ask to be assigned to the issue by posting a comment. If the
issue does not exist, please make a new issue. Issues give us context about what
you are contributing and expedite the process to getting your contributions
merged into Carbon. It's a win for everybody :tada:
### 6. Make a pull request

When you're at a good stopping place and you're ready for feedback from other
contributors and maintainers, **push your commits to your fork**:
Expand Down
28 changes: 14 additions & 14 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,21 +16,21 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Use Node.js 16.x
- name: Use Node.js 18.x
uses: actions/setup-node@v3
with:
node-version: '16.x'
node-version: '18.x'
- name: Run yarn dedupe
run: yarn dedupe --check

format:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Use Node.js 16.x
- name: Use Node.js 18.x
uses: actions/setup-node@v3
with:
node-version: '16.x'
node-version: '18.x'
- name: Install dependencies
run: yarn install --immutable --immutable-cache
- name: Check formatting of project files
Expand All @@ -40,10 +40,10 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Use Node.js 16.x
- name: Use Node.js 18.x
uses: actions/setup-node@v3
with:
node-version: '16.x'
node-version: '18.x'
- name: Install dependencies
run: yarn install --immutable --immutable-cache
- name: Lint JavaScript files
Expand All @@ -55,10 +55,10 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Use Node.js 16.x
- name: Use Node.js 18.x
uses: actions/setup-node@v3
with:
node-version: '16.x'
node-version: '18.x'
- uses: actions/cache@v3
id: cache
with:
Expand All @@ -81,10 +81,10 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Use Node.js 16.x
- name: Use Node.js 18.x
uses: actions/setup-node@v3
with:
node-version: '16.x'
node-version: '18.x'
- uses: actions/cache@v3
id: cache
with:
Expand Down Expand Up @@ -120,10 +120,10 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Use Node.js 16.x
- name: Use Node.js 18.x
uses: actions/setup-node@v3
with:
node-version: '16.x'
node-version: '18.x'
- uses: actions/cache@v3
id: cache
with:
Expand Down Expand Up @@ -178,10 +178,10 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Use Node.js 16.x
- name: Use Node.js 18.x
uses: actions/setup-node@v3
with:
node-version: '16.x'
node-version: '18.x'
- uses: actions/cache@v3
id: cache
with:
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/deploy-packages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ jobs:
with:
repository: carbon-design-system/carbon-website
ref: main
- name: Use Node.js 16.x
- name: Use Node.js 18.x
uses: actions/setup-node@v3
with:
node-version: '16.x'
node-version: '18.x'
registry-url: 'https://registry.npmjs.org'
- name: Update dependencies
run: |
Expand Down Expand Up @@ -63,10 +63,10 @@ jobs:
with:
repository: carbon-design-system/design-language-website
ref: master
- name: Use Node.js 16.x
- name: Use Node.js 18.x
uses: actions/setup-node@v3
with:
node-version: '16.x'
node-version: '18.x'
registry-url: 'https://registry.npmjs.org'
- name: Update dependencies
run: |
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/deploy-react-storybook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,10 @@ jobs:
runs-on: macos-11
steps:
- uses: actions/checkout@main
- name: Use Node.js 16.x
- name: Use Node.js 18.x
uses: actions/setup-node@v3
with:
node-version: '16.x'
node-version: '18.x'
- name: Install dependencies
run: yarn install --immutable --immutable-cache
- name: Build project
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/nightly-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ jobs:
runs-on: macos-11
steps:
- uses: actions/checkout@main
- name: Use Node.js 16.x
- name: Use Node.js 18.x
uses: actions/setup-node@v3
with:
node-version: '16.x'
node-version: '18.x'
- name: Install dependencies
run: yarn install --immutable --immutable-cache --check-cache
- name: Build project
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ jobs:
steps:
- uses: actions/checkout@v3

- name: Use Node.js 16.x
- name: Use Node.js 18.x
uses: actions/setup-node@v3
with:
node-version: '16.x'
node-version: '18.x'
registry-url: 'https://registry.npmjs.org'

- name: Install dependencies
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/sync-generated-files.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Use Node.js 16.x
- name: Use Node.js 18.x
uses: actions/setup-node@v3
with:
node-version: '16.x'
node-version: '18.x'
- name: Install dependencies
run: yarn install --immutable --immutable-cache
- name: Build project
Expand Down
20 changes: 10 additions & 10 deletions .github/workflows/v10-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ jobs:
steps:
- uses: actions/checkout@v3

- name: Use Node.js 16.x
- name: Use Node.js 18.x
uses: actions/setup-node@v3
with:
node-version: '16.x'
node-version: '18.x'
- name: Run yarn dedupe
run: yarn dedupe --check

Expand All @@ -28,10 +28,10 @@ jobs:
- uses: actions/checkout@v3
with:
ref: v10
- name: Use Node.js 16.x
- name: Use Node.js 18.x
uses: actions/setup-node@v3
with:
node-version: '16.x'
node-version: '18.x'
- name: Install dependencies
run: yarn install --immutable --immutable-cache
- name: Check formatting of project files
Expand All @@ -43,10 +43,10 @@ jobs:
- uses: actions/checkout@v3
with:
ref: v10
- name: Use Node.js 16.x
- name: Use Node.js 18.x
uses: actions/setup-node@v3
with:
node-version: '16.x'
node-version: '18.x'
- name: Install dependencies
run: yarn install --immutable --immutable-cache
- name: Lint JavaScript files
Expand All @@ -60,10 +60,10 @@ jobs:
- uses: actions/checkout@v3
with:
ref: v10
- name: Use Node.js 16.x
- name: Use Node.js 18.x
uses: actions/setup-node@v3
with:
node-version: '16.x'
node-version: '18.x'
- uses: actions/cache@v3
id: cache
with:
Expand All @@ -88,10 +88,10 @@ jobs:
- uses: actions/checkout@v3
with:
ref: v10
- name: Use Node.js 16.x
- name: Use Node.js 18.x
uses: actions/setup-node@v3
with:
node-version: '16.x'
node-version: '18.x'
- uses: actions/cache@v3
id: cache
with:
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/v10-deploy-react-storybook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@ jobs:
steps:
- uses: actions/checkout@v3

- name: Use Node.js 16.x
- name: Use Node.js 18.x
uses: actions/setup-node@v3
with:
node-version: '16.x'
node-version: '18.x'
- name: Install dependencies
run: yarn install --immutable --immutable-cache
- name: Build project
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/v10-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ jobs:
steps:
- uses: actions/checkout@v3

- name: Use Node.js 16.x
- name: Use Node.js 18.x
uses: actions/setup-node@v3
with:
node-version: '16.x'
node-version: '18.x'
registry-url: 'https://registry.npmjs.org'

- name: Install dependencies
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/version.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@ jobs:
- uses: actions/checkout@v3
with:
fetch-depth: '0'
- name: Use Node.js 16.x
- name: Use Node.js 18.x
uses: actions/setup-node@v3
with:
node-version: '16.x'
node-version: '18.x'
registry-url: 'https://registry.npmjs.org'
- uses: actions/cache@v3
id: cache
Expand Down
2 changes: 1 addition & 1 deletion .nvmrc
Original file line number Diff line number Diff line change
@@ -1 +1 @@
16.19
18.14
Loading

0 comments on commit 4455201

Please sign in to comment.