贡献指南
欢迎你为 ALLinSSL 项目做出贡献!我们非常感谢社区的支持。
你可以通过多种方式参与贡献:
报告 Bug (Report Bugs)
如果你在使用 ALLinSSL 时遇到了问题或发现了 Bug,请通过以下方式报告:
- 搜索现有 Issue: 在提交新 Bug 报告之前,请先在 GitHub Issues 中搜索是否已有类似报告。
- 创建新 Issue: 如果没有找到相关的 Issue,请创建一个新的 Issue。
- 标题: 清晰地描述问题。
- 内容: 提供尽可能详细的信息,包括:
- 你使用的 ALLinSSL 版本。
- 你的操作系统和环境信息。
- 复现问题的具体步骤。
- 期望的结果是什么。
- 实际发生了什么(包括错误消息、截图等)。
提交功能请求 (Feature Requests)
如果你对 ALLinSSL 有新的功能想法或改进建议:
- 搜索现有 Issue: 同样,先在 GitHub Issues 中搜索是否已有类似的功能请求。
- 创建新 Issue: 创建一个新的 Issue,清晰地描述你想要的功能:
- 说明这个功能要解决什么问题或带来什么价值。
- 描述你期望的功能是如何工作的。
- (可选) 提供一些使用场景示例。
参与代码贡献 (Code Contributions)
我们欢迎代码贡献!如果你想修复 Bug 或实现新功能,请遵循以下流程:
- Fork 仓库: Fork ALLinSSL 主仓库 到你自己的 GitHub 账号。
- Clone 你的 Fork:
git clone https://github.com/YOUR_USERNAME/allinssl.git
- 创建分支:
git checkout -b my-feature-or-fix
(使用有意义的分支名) - 进行修改: 编写你的代码和测试。
- Commit 修改:
git commit -am 'feat: Add some feature'
(遵循一定的 Commit 规范,如 Conventional Commits) - Push 到你的 Fork:
git push origin my-feature-or-fix
- 创建 Pull Request (PR): 在 GitHub 上,从你的分支向
allinssl/allinssl
的主分支(通常是main
或master
)发起 Pull Request。- 在 PR 描述中清晰说明你做了什么修改,解决了哪个 Issue (如果相关,使用
Fixes #123
)。
- 在 PR 描述中清晰说明你做了什么修改,解决了哪个 Issue (如果相关,使用
项目维护者会审查你的 PR,并可能提出修改建议。一旦通过,你的代码就会被合并!
改进文档 (Documentation)
发现文档有错误、不清晰或缺失?改进文档也是重要的贡献!
- 你可以直接在文档页面底部找到"在 GitHub 上编辑此页面"的链接,直接在线修改并发起 PR。
- 或者按照代码贡献的流程来修改文档文件。
感谢你的时间和贡献!