Merge pull request #1054 from linwumingshi/feature/Contributing

docs: 📝 add contributing guidelines in English and Chinese

Author: shalousun

CONTRIBUTING.md

@@ -0,0 +1,34 @@
+# Contributing
+
+Thank you for your interest in contributing to `smart-doc`! For detailed guidelines on how to contribute, please review our official [**Contribution Guide**](https://smart-doc-group.github.io/guide/community/contributing).
+
+## Key Highlights
+Before submitting a Pull Request (PR), please ensure:
+- 📌 **Discuss new features**: Start with an [Issue](https://github.com/smart-doc-group/smart-doc/issues) to align on proposed changes.
+- 🧩 **Single-focused PRs**: Submit one fix or feature per PR to simplify reviews.
+- 🌍 **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.
+
+## Documentation and Examples
+If your contribution involves:
+- 🛠️ **Configuration changes**:
+	- Check if your PR adds or modifies configurations (e.g., new parameters, default value updates).
+	- Update or add corresponding documentation in the [`smart-doc-group.github.io`](https://github.com/smart-doc-group/smart-doc-group.github.io/tree/master/docs).
+- 📚 **New features**:
+	- Provide usage examples in the [`smart-doc-example-cn`](https://github.com/smart-doc-group/smart-doc-example-cn) repository to demonstrate implementation.
+
+
+## How to Contribute
+1. Fork the repository and clone it locally.
+2. Create a new branch for your changes.
+3. Test your modifications using `smart-doc` (see [Quick Start](https://smart-doc-group.github.io/guide/getting-started)).
+4. Format code with `mvn spring-javaformat:apply`.
+5. Submit a PR to the main repository.
+
+## Community Engagement
+- 📰 Share your use cases or articles in the [Discussions](https://github.com/smart-doc-group/smart-doc/discussions) section.
+- ❓ Help answer questions in the `Help` category.
+- 💡 Propose ideas or showcase tools in `Ideas` or `Show and tell`.
+
+Your contributions are vital to making `smart-doc` better for everyone. Thank you!  

CONTRIBUTING_CN.md

@@ -0,0 +1,33 @@
+# 贡献指南
+
+感谢您对参与 `smart-doc` 贡献的兴趣！详细的贡献指引请参考我们的官方 [**贡献指南文档**](https://smart-doc-group.github.io/zh/guide/community/contributing)。
+
+## 核心要求
+提交 Pull Request (PR) 前请确保：
+- 📌 **新功能需先讨论**：通过 [Issue](https://github.com/smart-doc-group/smart-doc/issues) 与社区对齐需求，避免重复劳动。
+- 🧩 **单焦点 PR**：每次提交仅包含一个修复或功能，简化代码审查。
+- 🌍 **英文注释**：代码注释使用英文，支持国际化协作。
+- ✅ **代码质量**：遵循 [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) 文档。
+
+## 文档与示例要求
+若贡献包含以下内容：
+- 🛠️ **配置项变更**：
+	- 检查 PR 是否新增/修改配置（如新增参数、修改默认值）。
+	- 在 [`smart-doc-group.github.io`](https://github.com/smart-doc-group/smart-doc-group.github.io/tree/master/docs) 中补充或更新对应文档。
+- 📚 **新功能实现**：
+	- 在 [`smart-doc-example-cn`](https://github.com/smart-doc-group/smart-doc-example-cn) 仓库提供使用示例，便于其他用户快速理解。
+
+## 贡献步骤
+1. Fork 仓库并本地克隆。
+2. 创建新分支进行修改。
+3. 使用 `smart-doc` 测试改动（参考 [快速入门](https://smart-doc-group.github.io/zh/guide/getting-started)）。
+4. 执行 `mvn spring-javaformat:apply` 格式化代码。
+5. 向主仓库提交 PR。
+
+## 社区互动
+- 📰 在 [Discussions](https://github.com/smart-doc-group/smart-doc/discussions) 分享使用案例或技术文章。
+- ❓ 在 `Help` 分类帮助解答用户疑问。
+- 💡 在 `Ideas` 或 `Show and tell` 提出建议或展示相关工具。
+
+您的贡献将帮助 `smart-doc` 更好地服务全球开发者！感谢支持！