贡献指南
欢迎来到smart-doc社区！感谢您为smart-doc贡献代码、文档及案例！ smart-doc自2018年开源以来，受到社区很多小伙伴的关注。 衷心地希望越来越多的社区同学能参与到smart-doc项目中来， 我们一起把smart-doc做好！
如何贡献？
如果您想为smart-doc做出贡献，可以按照以下步骤进行：
1、在GitHub上Fork smart-doc的代码库到您的个人仓库中。
2、Clone您fork的项目到本地仓库，创建其他分支以进行修改。
3、在本地环境中运行smart-doc，并确认所做的改动是否生效。可参考 快速开始 了解如何启动smart-doc并生成API文档。
4、完成修改后，推送提交并提交Pull Request给smart-doc的主仓库。 请参考Pull Request流程 来提交合并请求。
5、等待社区Committer审核并合并您的Pull Request。
6、如果合并成功，恭喜您已经成功做出了贡献！
TIP
为了方便社区后续国际化推广，提pr请用英文，可以使用文心一言、科大讯飞星火等GPT工具辅助翻译成英文
注意的事项
在为smart-doc提交贡献时，请注意以下事项：
如果您想添加新功能或者功能升级，请先开
Issue讨论。为了方便作者审核代码，建议每个
Pull Request只提交单一问题的修复或者功能添加，避免大规模变更。smart-doc作为一个为全球开发者服务的工具，提交代码时请使用英文注释，也是方便社区更好的做国际化推广。请遵守代码风格约定，确保代码可读性和易维护性。
请确保所有提交的代码都有单元测试覆盖，以确保代码质量。
如有必要，更新相应的文档以反映您的更改。
最后，我们欢迎任何形式的贡献，包括但不限于代码、文档、
Issue提出等。
Code review
所有的代码都需要经过Committer进行review。以下是我们推荐的一些原则：
- 可读性：所有提交请遵循良好的代码规范、文档规范。
- 优雅性：代码简练、复用度高，有着完善的设计。
- 测试：对于普通的方法在
smart-doc上添加单元测试，对于用户接口代码请在smart-doc-example-cn 添加测试用例并完成提交测试验证。
案例分享
我们非常欢迎您分享任何关于smart-doc的使用案例。欢迎大家投稿，分享smart-doc的使用案例。 对于优秀的案例分享者，社区也会后续也会给予一些奖励。
参与社区讨论
如果您在使用smart-doc中遇到任何问题，欢迎到Discussions进行交流互动。 也欢迎在这里帮助其他使用者解答一些使用中的问题。
Discussion分类：
Announcements：smart-doc官方公告。Help：使用smart-doc中遇到问题，想在社区寻求帮助。Ideas：关于smart-doc的一些想法，欢迎随时交流。Show and tell：可以在这里展示任何跟smart-doc相关的工作，例如一些工具、案例等。