Skip to content

Latest commit

 

History

History
27 lines (18 loc) · 633 Bytes

CONTRIBUTING.md

File metadata and controls

27 lines (18 loc) · 633 Bytes

贡献指南

感谢你对 ReadShell 项目的关注!欢迎任何形式的贡献。

开发环境设置

  1. 确保安装了 Node.js >= 20
  2. Fork 并克隆仓库
  3. 安装依赖: npm install
  4. 运行测试: npm test

提交代码

  1. 创建功能分支: git checkout -b feature/your-feature
  2. 提交更改(使用中文提交信息)
  3. 推送并创建 Pull Request

代码规范

  • 使用 TypeScript 编写
  • 运行 npm run lint 检查代码
  • 运行 npm run format 格式化代码
  • 确保所有测试通过: npm test

许可证

参与贡献即表示你同意你的代码以 MIT 许可证发布。