Skip to content
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
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ You can find the official docs for the Click UI design system and component libr
- [Applying Fixes to Stable Versions](#applying-fixes-to-stable-versions)
- [Switching Release Modes](#switching-release-modes)
* [Contributing](#contributing)
- [Component RFC](#component-rfc)
- [Conventional commits](#conventional-commits)

## Requirements
Expand Down Expand Up @@ -598,6 +599,25 @@ Here's what changes in package.json:
```
Always include a changeset to ensure each promotion reflects real, trackable changes.

### Component RFC

To propose a new component, open an RFC using the [Component RFC template](https://github.com/ClickHouse/click-ui/compare/main...branchName?template=component_rfc.md).

> [!NOTE]
> Replace the <branchName> in the Component RFC template URL by your branch name.
For example, to open a Component RFC for branch name `feat/slider`, you'd open the URL:

```sh
https://github.com/ClickHouse/click-ui/compare/main...feat/slider?template=component_rfc.md
```

For GitHub CLI users:

```sh
gh pr create --template component_rfc.md
```

### Conventional commits

We prefer to commit our work following [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0) conventions. Conventional Commits are a simple way to write commit messages that both people and computers can understand. It help us keep track fo changes in a consistent manner, making it easier to see what was added, changed, or fixed in each commit or update.
Expand Down
Loading