diff --git a/docs/contributing.md b/docs/contributing.md index e2965cdf..d0f0310b 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -53,3 +53,11 @@ pnpm tauri build - Install Gitmoji: `pnpm install -g gitmoji-cli` - Commit changes: `gitmoji commit` - Push changes: `git push` + +### Submitting Suggestions + +If the functionality being submitted spans a large time period, it is recommended to pull the dev branch every day, as the project may undergo significant code refactoring at any time. + +If the functionality being submitted is small with a limited scope of code changes, you can directly modify and commit on the dev branch. + +If the functionality being submitted is large with extensive code changes, it is recommended to create a new branch first, and then modify and commit on the new branch. diff --git a/docs/zh/contributing.md b/docs/zh/contributing.md index 497daf58..da6e4e48 100644 --- a/docs/zh/contributing.md +++ b/docs/zh/contributing.md @@ -70,3 +70,11 @@ pnpm tauri build - 安装 Gitmoji: `pnpm install -g gitmoji-cli` - 提交更改: `gitmoji commit` + +### 提交建议 + +如果提交的功能时间跨度较大,建议每天都拉取一下dev分支,因为项目随时可能会有大大小小的代码重构。 + +如果提交的功能较小,代码改动范围较小,可以直接在dev分支上修改并提交。 + +如果提交的功能较大,代码改动范围较大,建议先创建一个新的分支,然后在新的分支上修改并提交。