74 lines
2.5 KiB
Markdown
74 lines
2.5 KiB
Markdown
# 贡献指南
|
||
|
||
感谢您有兴趣为项目做出贡献！遵循以下准则和步骤，以确保您的贡献符合项目的要求。
|
||
|
||
## 安装依赖
|
||
|
||
在开始贡献之前，请确保您的开发环境满足以下要求：
|
||
|
||
- Node.js（推荐使用最新稳定版本）
|
||
- pnpm
|
||
|
||
## 克隆项目
|
||
|
||
使用 Git 克隆项目到本地开发环境：
|
||
|
||
```sh
|
||
git clone https://gitee.com/yeyang52/yenai-plugin
|
||
或
|
||
git clone https://github.com/yeyang52/yenai-plugin
|
||
```
|
||
|
||
## 安装依赖
|
||
|
||
运行以下命令安装项目所需的依赖项：
|
||
|
||
```sh
|
||
pnpm install
|
||
pnpm husky
|
||
```
|
||
## 开发过程
|
||
|
||
在进行开发之前，请遵循以下准则：
|
||
|
||
- 严格遵守项目的 ESLint 规则，确保代码的质量和一致性。
|
||
- 尽量遵循项目的代码风格和命名约定，以保持代码的可读性。
|
||
- 提交的代码应该是经过测试的，并且不会破坏现有的功能。
|
||
|
||
## Git 提交规范
|
||
|
||
为了确保提交的代码符合项目的要求，我们使用 Husky 和 lint-staged 进行 Git 提交时的规范检测。请按照以下步骤进行提交：
|
||
|
||
1. 在进行 Git 提交之前，确保您的代码已经通过 ESLint 的检查。
|
||
|
||
2. 运行以下命令进行 Git 提交，请您遵守[gitmoji](https://gitmoji.dev/)规范来提交commit：
|
||
|
||
```sh
|
||
git add .
|
||
pnpm run commit
|
||
```
|
||
在提交时，Husky 会自动运行预定义的 Git 钩子脚本，包括对代码规范的检测，同时会使用[gitmoji-cli](https://github.com/carloscuesta/gitmoji)进行交互式提交。
|
||
|
||
3. 如果提交的代码不符合项目的规范要求，您将会收到相应的错误提示。请根据提示信息进行修改和调整，直到提交的代码符合要求。
|
||
|
||
## 提交拉取请求
|
||
|
||
当您准备好将您的贡献合并到主项目中时，请按照以下步骤提交拉取请求：
|
||
|
||
1. 将您的本地分支推送到远程仓库：
|
||
|
||
```sh
|
||
git push origin master
|
||
```
|
||
|
||
2. 在项目仓库的页面上，点击 "New Pull Request"（或类似的按钮），创建一个新的拉取请求。
|
||
|
||
3. 填写拉取请求的相关信息，包括描述您的贡献的详细内容和目的。
|
||
|
||
4. 提交拉取请求后，项目维护者将会审核您的代码，并与您协作以确保贡献的质量和一致性。
|
||
|
||
## 感谢您的贡献
|
||
|
||
非常感谢您为项目做出的贡献！您的工作对于项目的发展和成功至关重要。项目维护者会尽快审查您的贡献并与您合作，以确保其顺利合并到主项目中。
|
||
|
||
如果您有任何问题或需要进一步的帮助，请随时与项目维护者进行沟通。 |