CONTRIBUTING.md

Contributing Guide

We appreciate your interest in improving this project!
All contributions — from small bug fixes to major feature additions — are highly valued.

---

Table of Contents

• Local Development
• Storybook
• Pull Requests
• Publishing a New Version
• Development Guidelines

---

Local Development

After cloning the repository, install all dependencies:

npm install

Then build the local development environment:

npm run lerna:build

If you want to test your changes in another project, you can use npm link to link the local package.

---

Storybook

We provide a Storybook setup for component development and testing.

Start the Storybook environment with:

npm run storybook

Note: We are working on integrating Storybook with the chayns environment.
Some components relying on the chayns-api may not fully function within Storybook yet.

---

Pull Requests

If you find a bug or want to introduce a new feature, please follow these steps:

1. Fork this repository
2. Implement your changes and write clear, concise commit messages
3. Submit a Pull Request to the v5 branch of this repository

Please avoid including unrelated commits in your pull request.

---

Publishing a New Version

Before publishing a new version, ensure that all components are built and tested successfully.

Run:

npm run lerna:version

This command handles versioning and publishing to npm.

---

Development Guidelines

Please read our Development Guidelines
to understand the visual language, color system, and component design principles.

---

_{Maintained by the chayns-components team · Built with React, TypeScript and styled-components}