参与贡献

感谢关注 Birdpaper UI。欢迎通过 Issue、讨论和 Pull Request 一起完善组件库。提交前请先阅读 本地开发，确保能在本地跑通文档与测试。

贡献方式

• 报告缺陷：说明复现步骤、期望行为、实际行为，附上版本、浏览器与最小复现（可用文档站示例或 CodeSandbox）
• 功能建议：描述使用场景与动机，尽量给出 API / 交互草图
• 文档改进：错别字、示例、翻译、过时说明都欢迎
• 代码贡献：修 bug、补测试、新组件或增强现有组件

仓库地址：birdpaper-team/birdpaper-ui。

开始之前

1. 搜索是否已有相关 Issue / PR，避免重复劳动
2. 较大改动（新组件、破坏性变更）建议先开 Issue 讨论
3. Fork 仓库并基于最新默认分支创建功能分支：

git pull
git checkout -b feat/your-topic

开发检查清单

提交 PR 前建议完成：

pnpm docs:dev 下相关文档 / Demo 表现正常

涉及组件已补充或更新单元测试，pnpm test 通过

pnpm lint 无新增报错

若有公开 API 变更，已更新对应 docs/src/components/**/api.md 与示例

若有视觉令牌 / 深色相关改动，已核对 定制主题 与 深色模式 描述是否一致

提交信息

仓库使用 Conventional Commits 风格，推荐交互式生成：

pnpm cz

常用 type：

feat	新功能
fix	缺陷修复
docs	仅文档
style	不影响逻辑的格式 / 样式微调
refactor	重构（非 feat / fix）
perf	性能
test	测试
build	构建或依赖
ci	CI 配置
chore	杂项
revert	回滚

scope 可选（如 docs、packages、root，也允许自定义）。示例：

feat(packages): add InputNumber step strict mode
fix(packages): correct Select dropdown z-index
docs: complete local development guide

破坏性变更请在 body 中写明 BREAKING CHANGE:，或在讨论中提前说明迁移方式。

Pull Request

1. 将分支推送到你的 Fork
2. 向仓库默认分支发起 Pull Request
3. PR 描述建议包含：
   • 改动说明：解决了什么问题
   • 关联 Issue：如 Fixes #123
   • 验证方式：测试命令、文档路径、截图或录屏（UI 相关）
   • 破坏性变更：有则写清影响范围与迁移建议

保持 PR 尽量聚焦；大改动可拆成多个小 PR，便于评审。

Code Review

• 保持友好、具体；对事不对人
• 评审关注正确性、API 一致性、可访问性、文档与测试是否跟上
• 作者根据意见修改后，在对话中回复已处理项，方便继续跟进

合并后由维护者安排发版，变更会记录在 更新日志。

行为准则

参与本项目即表示你愿意：

• 尊重不同观点与经验水平
• 接受建设性反馈
• 以解决问题、改进项目为目标沟通

恶意行为、人身攻击或不适宜内容不可接受。情节严重时维护者可关闭 Issue / PR 或限制参与。

许可证

贡献的代码将默认以仓库 MIT License 授权。若无法接受，请勿提交贡献。

需要帮助？

• 先看 本地开发
• 在 GitHub Issue 中提问，并附上环境与最小复现
• 文档站与组件目录：组件目录