Skip to content
This repository was archived by the owner on Dec 4, 2025. It is now read-only.
Merged
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
22 changes: 22 additions & 0 deletions .github/workflows/pr-comment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,18 @@ jobs:
repository: ${{ github.repository }}
issue-number: ${{ github.event.number }}
body: |
@${{ github.event.pull_request.user.login }}

🔍 **Before proceeding, please review the contribution guidelines**
- [📖 Contribution Guide](https://github.com/smart-doc-group/smart-doc/blob/master/CONTRIBUTING.md)

This includes requirements for:
- ✅ Commit message format (Angular Convention. `feat`, `fix`, etc.)
- 🧹 Code style (execute `mvn spring-javaformat:apply`)
- 📄 Documentation updates (if config changes)
- 💡 Example code submission (for new features)


Thanks for your PR. :pray:
Please check again for your PR changes whether they contain any usage configuration change, such as `Add new configuration` or `Change default value of configuration`.
If so, please add or update documents (Markdown format) in the `docs/` directory of the repository [smart-doc-group/smart-doc-group.github.io](https://github.com/smart-doc-group/smart-doc-group.github.io/tree/master/docs).
Expand All @@ -29,6 +41,16 @@ jobs:

---


🔍 **提交前请务必完成以下检查**
- [📘 贡献指南](https://github.com/smart-doc-group/smart-doc/blob/master/CONTRIBUTING_CN.md)

需特别注意:
- ✅ 提交信息格式 (`feat`, `fix` 等类型)
- 🧹 代码风格(执行 `mvn spring-javaformat:apply`)
- 📄 文档更新(配置变更需同步更新 docs)
- 💡 示例代码(新功能需提供示例)

感谢您提交的PR。 :pray:
请再次查看您的PR内容,确认是否包含任何使用方式或配置参数的变更,如:`新增配置参数`、`修改默认配置`等操作。
如果是,请确保在提交之前,在仓库[smart-doc-group/smart-doc-group.github.io](https://github.com/smart-doc-group/smart-doc-group.github.io/tree/master/docs)中的`docs/`目录下添加或更新文档(Markdown格式)。
Expand Down
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ Before submitting a Pull Request (PR), please ensure:
- 🌍 **English comments**: Use English for code comments to support international collaboration.
- ✅ **Code quality**: Follow the [Spring Java Format](https://github.com/spring-io/java-format) style and add unit tests.
- 📄 **Update documentation**: Reflect your changes in relevant documentation [`smart-doc-group.github.io`](https://github.com/smart-doc-group/smart-doc-group.github.io/tree/master/docs). if needed.
- 📝 **Commit message guidelines**: All commits must follow the [Angular Commit Convention](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#commit).
- Use appropriate types: `feat`, `fix`, `docs`, `style`, `refactor`, `test`, `chore`, etc.
- Keep subject and body concise, avoiding vague terms like "update code".
- Reference related issues (e.g., `Closes #1234`) in the footer when applicable.

## Documentation and Examples
If your contribution involves:
Expand Down
4 changes: 4 additions & 0 deletions CONTRIBUTING_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@
- 🌍 **英文注释**:代码注释使用英文,支持国际化协作。
- ✅ **代码质量**:遵循 [Spring Java Format](https://github.com/spring-io/java-format) 风格,添加单元测试。
- 📄 **文档同步更新**:若涉及功能变更,请同步更新 [`smart-doc-group.github.io`](https://github.com/smart-doc-group/smart-doc-group.github.io/tree/master/docs) 文档。
- 📝 **提交信息规范**:所有提交需严格遵循 [Angular 提交规范](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#commit)。
- 使用标准类型:`feat`(新功能)、`fix`(修复)、`docs`(文档)、`style`(格式调整)、`refactor`(重构)、`test`(测试)、`chore`(构建/依赖管理)等。
- 主题与正文需简洁明确,避免“更新代码”等模糊描述。
- 若关联 Issue,需在页脚注明(如 `Closes #1234`)。

## 文档与示例要求
若贡献包含以下内容:
Expand Down