如何为开源项目和社区做贡献 -- 你应该知道的十件事（二）——如何提Issue?

3. 如何为开源做贡献

? 上面我们讲了这么多给开源项目和社区做贡献的好处，可能有一些小伙伴就开始心动了，下面我们就展开讲述一下有哪些途径可以为开源做贡献，具体是如何做的。

问题二：为开源项目做贡献–如何提Issue？

? 首先向大家介绍一下第一种方式，也是入门级别相对简单也是比较容易实现的，就是给开源项目提交Issue。开源项目在发布时尽管发布者或者团队已经做了很详尽的测试，但由于使用对象以及使用环境等因素的影响，使用者难免会出现相关问题以及新的使用需求，因此我们提交Issue可以包括以下内容：

• Bug报告：你发现了代码中的错误或异常行为。
• 功能请求：你希望项目中添加一个新功能或改进现有功能。
• 问题咨询：你在使用或配置项目时遇到了困难。
• 文档改进：你认为项目的文档需要更清晰或更完整。

? 当然，这是是我列出来的常见内容，具体还是看使用者需求，因此提交Issue一定是该开源项目的使用者，再使用时碰到难以解决的问题时我们就可以通过提交Issue方式解决，这样不仅可以帮助自己解决问题，还可以促进开源项目的改进与发展，属于两全其美的事情。

? 再确定了你的问题以及你要提交Issue时，你需要先做一步问题检查，检查一下是否有小伙伴提交过相同的Issue，这样可以避免提交重复的问题，给开源项目发布人员带来不必要的负担，也是对做开源工作对其他人员的最起码的尊重。如果你发现这是一个新的问题，之前并没有人提过，那么好，你就可以开始提交你的Issue了，主要包括以下几个步骤：

（1）创建一个新的Issue

此处以OpenVINO厂库为例，创建一个新的Issue。

OpenVINO官方提供了不同的Issue类型选择，此处可以根据你所需要的问题类型进行选择。

（2）编写Issue标题：

? 使用简洁明了的标题来描述你的问题或请求，好的标题可以快速地让维护者了解Issue的主要内容。

（3）详细描述问题：

? 官方人员在解决你所提出来的问题时，会首先复现你所出现的问题，因此在提交Issue时，一定要详细描述你所提交的问题复现步骤以及结果输出情况和日志，总的来说可以包括以下几个部分：

• 上下文：描述你在什么情况下遇到的问题。
• 重现步骤：如果是bug报告，详细列出如何重现这个问题。
• 期望结果与实际结果：说明你的期望是什么，以及实际发生了什么。
• 相关信息：如操作系统、软件版本、依赖库版本等。
• 附加信息：
  • 日志和错误消息：如果有相关的日志或错误消息，请附加或链接到它们。
  • 屏幕截图和视频：如果它们有助于解释问题，可以附加在后面。
    

? 最后就是要使用Markdown格式来组织你的描述，使其易于阅读。并始终保持礼貌和尊重，因为开源维护者是在免费为你提供帮助。

（4）提交并等待回复

? 最后在详细描述完问题内容后就可以提交问题了，提交后就可以等待光放人员的回复，如光官方人员在复现时或者解决时有什么问题，也会向你进行反馈，因此可以时刻关注问题的动态。最后在问题解决后一定要礼貌感谢一下官方人员。