nodejieba/CONTRIBUTING.md

chinese word segmentation for node

# 贡献指南

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

## 开发环境设置

1. 克隆仓库并安装依赖：

```bash
git clone --recursive https://github.com/yanyiwu/nodejieba.git
cd nodejieba
npm install
```

2. 运行测试确保一切正常：

```bash
npm test
```

## 提交代码

1. 创建一个新的分支进行开发：

```bash
git checkout -b feature/your-feature-name
```

2. 进行代码修改
3. 确保所有测试通过：

```bash
npm test
```

4. 提交您的更改：

```bash
git commit -m "描述您的更改"
```

5. 推送到您的分支：

```bash
git push origin feature/your-feature-name
```

6. 创建一个Pull Request

## 代码风格

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

## 测试

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

## 文档

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

## 版本发布

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

## 许可证

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

## 问题和讨论

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

感谢您的贡献！