1. 概述
提问是一个非常重要的技能,无论是在学习技术还是实践项目中,都需要不断地根据自身的需要向别人请教问题。Github作为全球最大的开源社区,提问问题的方式和技巧对于得到有效的回答至关重要。本文将会分享一些关于Github如何正确提问的技巧,让你更快的得到有效的帮助。
2. 提供问题的背景
2.1 为什么提供详细的背景信息很重要?
在提问之前,需要明确一个问题的上下文。如果你仅仅粘贴代码或者描述一个工作流问题,那么其他人很难理解你的问题需要解决哪些具体问题。因此,当你发起一个问题时,请为其他人提供尽可能多的背景信息。
2.2 应该提供哪些背景信息?
你需要提供有关你的代码、环境、版本、操作系统等等方方面面的信息。本文不会讨论每个可能的因素,但以下是一些通常需要提供的背景信息:
你使用的软件和工具的版本号
问题出现的操作系统和环境,比如是在Windows、Mac、Linux或其他平台上
你做了什么
你出现了什么样的错误,或者你如何知道代码有问题
3. 描述你的问题
3.1 避免使用模糊的问题描述
模糊的问题描述会使其他人难以理解你的问题。比如,如果你的问题描述是“我的代码报错了,请帮我看看”,那么这样的描述不具备实质性的信息。其他人很难理解你的问题在哪里。因此,描述问题时,请保证自己的描述足够具体,有针对性,使得其他人很容易了解你的问题。
3.2 能够 Reproduce 问题
为了更好地帮助你解决问题,其他人希望得到一个可以复现你的问题的方法。因此,提问时,请务必说明如何复现你的问题。如果你的问题是关于一个程序的,提供能够在其他人本地复现这个问题的方法;如果是关于一个网站的,提供可以复制粘贴的链接以及其他需要登录的信息。
3.3 使用正确的标点和格式
在描述问题的时候,你需要以一个完整的问题做结论,但更重要的是,你需要使用正确的标点和格式,以便在理解你的问题时更容易。以下是一些格式和标点必须考虑的细节:
使用清晰的语句并分段。
使用正确的标点符号如问号、句号、逗号等
请不要写全大写的文本,这会被理解为你在大喊大叫。
4. 诚实并感恩
4.1 诚实地描述问题
时刻牢记,在提问时,你必须真诚地描述你的问题,不要隐瞒一些不重要的细节或者造假。遇到问题时,我们都希望得到帮助,而提高问题描述的质量是让人们帮你的第一个前提。
4.2 记得感谢那些帮助过你的人
如果有人花时间回答你的问题,请记得回复答案并表示感谢。不要忘记在成功解决问题时为他们点赞和感谢,并向他们致以诚挚的问候。
5. 总结
在 Github 上,正确和清晰地提问是你获得解决方案的关键。一个清晰而明确的问题描述将有助于其他人更好地理解你的问题,从而更好地回答它。当你获得帮助时,请不要忘记要发自内心地表示感激和感谢。
git clone https://github.com/freeCodeCamp/coding-interview-university.git