Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: 📝 update pull request process documentation #157

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# Smart-Doc VitePress 文档


[English Doc](/README.md)

## 项目目录
```shell
.
Expand Down
15 changes: 11 additions & 4 deletions docs/en/guide/community/pull-request-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,26 @@ To prevent conflicts caused by changes in the upstream repository, you should `s
## 2. Sync from Remote Repository && Resolve Conflicts Locally
1. Use the `git pull` command locally to sync code from the remote repository

2. If there are no conflicts, that's great. If there are conflicts, [refer to about-merge-conflicts](https://docs.github.com/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/about-merge-conflicts) to resolve them.
2. If there are no conflicts, that's great. If there are conflicts, refer to [about-merge-conflicts](https://docs.github.com/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/about-merge-conflicts) to resolve them.

## 3. Commit && Push to Remote Repository

::: warning Code Formatting
Please use `mvn spring-javaformat:apply` to format your code before committing.
:::

1. A `pull request` can only contain one `commit`. If there are multiple `commits`, use the [Rebase command to merge commits](community/rebase-option.md)
1. A `pull request` can only contain one `commit`. If there are multiple `commits`, use the [Rebase command to merge commits](rebase-option)
2. Each `commit` should add corresponding modification records in the `CHANGELOG`.
3. Use `git push` or `git push -f`(add `-f` if merging remote `commits`) to push `commit` to the remote repository.
3. Ensure the `commit message` follows the [Angular Commit Guidelines](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#commits) for proper formatting.
4. Use `git push` or `git push -f`(add `-f` if merging remote `commits`) to push `commit` to the remote repository.

- [Reference document for Rebase operation](rebase-option)

::: tip
- [Conventional Commits Specification](https://www.conventionalcommits.org/en/v1.0.0/)
- [Angular Commit Guidelines](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#commits)
:::

- [Reference document for Rebase operation](community/rebase-option)

## 4. Create Pull Request

Expand Down
15 changes: 11 additions & 4 deletions docs/zh/guide/community/pull-request-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,26 @@
## 2. 从远程仓库同步 && 本地解决冲突
1. 在本地使用`git pull`命令从远程仓库同步代码

2. 如果没有冲突,那太好了。如果存在冲突,[请参考 about-merge-conflicts](https://docs.github.com/zh/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/about-merge-conflicts)解决
2. 如果没有冲突,那太好了。如果存在冲突,请参考 [about-merge-conflicts](https://docs.github.com/zh/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/about-merge-conflicts) 解决

## 3. 提交commit && 推送到远程仓库

:::warning 代码格式化
提交commit之前请使用 `mvn spring-javaformat:apply`进行代码格式化
:::

1. 一个`pull request`中只能一个`commit`。如果有多个`commit`,使用 [Rebase命令合并commit](rebase-option.md)
1. 一个 `pull request` 中只能一个 `commit` 。如果有多个 `commit` ,使用 [Rebase命令合并commit](rebase-option)
2. 每个`commit`都要在`CHANGELOG`中添加对应的修改记录。
3. `git push` 或则 `git push -f`(合并了远程`commit`添加 `-f`)推送`commit`到远程仓库
3. 确保 `commit` 提交信息符合 [Angular 提交规范](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#commits)。
4. `git push` 或则 `git push -f` (合并了远程 `commit` 添加 `-f` ) 推送`commit`到远程仓库

- [Rebase操作参考文档](rebase-option)

::: tip
- [Conventional Commits Specification](https://www.conventionalcommits.org/en/v1.0.0/)
- [Angular 提交规范](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#commits)
:::

- [Rebase操作参考文档](rebase-option.md)

## 4. 创建 pull request

Expand Down
2 changes: 1 addition & 1 deletion docs/zh/guide/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> smart-doc官方目前已经开发完成Maven插件和Gradle插件,本章以Maven插件举例.

> Gradle插件配置请 [跳转](plugins/gradle.md).
> Gradle插件配置请 [跳转](plugins/gradle).


## 最小化配置
Expand Down
Loading