English | 简体中文
Thank you for taking your time to contribute and make this project better! Here are some guidelines to help you get started. Please make sure to take a moment and read through them before submitting your contributions.
This project is governed by the Contributor Covenant Code of Conduct. By participating, you are expected to adhere to it.
All work happens directly on GitHub
. Both core team members and external contributors send pull requests which go through the same code review
process.
This project follows semantic versioning. We release patch versions for bug fixes or other changes that do not change the behavior of the API, minor versions for new features that are backward-compatible, and major versions for any breaking changes.
Every significant change is documented in the changelog file.
We use Github issues for bug reports and feature requests. Before reporting an issue, please make sure you have searched for similar issues as they may have been already answered or being fixed. For bug reporting, please include the minimum code that can be used to reproduce the problem. For feature request,
- Fork the repository,and create your branch from
main
. For new feature, please submit your changes directly to thefeature
branch. Other changes should go againstmain
branch. - Use
pnpm install
install the dependencies - Use
pnpm run dev
start project,RUNpnpm run play
start theplayground
,RUNpnpm run docs
to write docs。 - Make changes to the codebase. Please add tests if applicable.
- Make sure the test suite passes with
pnpm run test
. - Use
pnpm run test:ci
to RUNCI
tests before you commit your code. - Commit your changes, adhering to the Commit Guidelines.
- Open a new pull request,referencing corresponding issues if available.
Commit messages are required to follow the conventional-changelog standard:
<type>[optional scope]: <description>
[optional body]
[optional footer(s)]
The following is a list of commit types:
- feat: A new feature or functionality
- fix: A bug fix
- docs: Documentation only changes
- style: Code formatting or component style changes
- refactor: Code changes that neither fixes a bug nor adds a feature.
- perf: Improve performance.
- test: Add missing or correct existing tests.
- chore: Other commits that don’t modify src or test files.
This repository is managed by pnpm
and includes the following packages:
onu-ui
: UI component maindocs
: Component documentation site@onu-ui/components
: UI component library@onu-ui/preset
: UI component preset@onu-ui/utils
: UI component utility@onu-ui/cli
: UI component CLI
By contributing your code to the repository, you agree to license your contribution under the MIT license.