Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
78 lines (49 loc) · 1.33 KB

CONTRIBUTING.md

File metadata and controls

78 lines (49 loc) · 1.33 KB

贡献指南

感谢您考虑为NodeJieba项目做出贡献！以下是一些指导原则，帮助您更好地参与项目开发。

开发环境设置

  1. 克隆仓库并安装依赖：
git clone --recursive https://github.com/yanyiwu/nodejieba.git
cd nodejieba
npm install
  1. 运行测试确保一切正常：
npm test

提交代码

  1. 创建一个新的分支进行开发：
git checkout -b feature/your-feature-name
  1. 进行代码修改
  2. 确保所有测试通过：
npm test
  1. 提交您的更改：
git commit -m "描述您的更改"
  1. 推送到您的分支：
git push origin feature/your-feature-name
  1. 创建一个Pull Request

代码风格

  • 遵循项目现有的代码风格
  • 对于JavaScript代码，使用2个空格缩进
  • 对于C++代码，遵循现有的代码风格

测试

  • 为新功能添加测试用例
  • 确保所有测试通过

文档

  • 更新README.md以反映您的更改
  • 为新功能添加文档注释

版本发布

版本发布由项目维护者负责。如果您认为应该发布新版本，请在Issue中提出。

许可证

通过贡献代码，您同意您的贡献将在MIT许可证下发布。

问题和讨论

如果您有任何问题或想法，请在GitHub Issues中提出。

感谢您的贡献！