Coding Starter Projects

编码启动项目

一个基本存储库，可以与他人分享您的入门项目并帮助他们成长！

首先，感谢您抽出宝贵的时间做出贡献！

鼓励和重视所有类型的贡献。请参阅目录的不同方法，以帮助和详细说明该项目如何处理它们。在做出贡献之前，请确保阅读相关部分。这将使我们的维护人员变得容易得多，并为所有相关人员提供了体验。社区期待您的贡献。

而且，如果您喜欢这个项目，但没有时间做出贡献，那很好。还有其他简单的方法来支持该项目并表示感谢，我们也很高兴：

• 明星项目
• 鸣叫
• 在您项目的读数中参考该项目
• 在当地聚会上提及该项目，并告诉您的朋友/同事

目录

• 行为守则
• 我有一个问题
• 我想贡献
• 报告错误
• 建议增强

行为守则

该项目和参与其中的每个人都受到贡献。MD行为守则。通过参加，您应该维护此代码。请向<>报告不可接受的行为。

我有一个问题

如果您想问一个问题，我们假设您已经阅读了可用的文档。

在提出问题之前，最好搜索可能对您有帮助的现有问题。如果您发现了一个合适的问题并且仍然需要澄清，则可以在本期中写下您的问题。也建议先搜索互联网以获取答案。

如果您仍然觉得需要提出问题并需要澄清，我们建议以下内容：

• 打开一个问题。
• 为您遇到的内容提供尽可能多的上下文。
• 根据似乎相关的内容提供项目和平台版本（NODEJS，NPM等）。

然后，我们将尽快解决这个问题。

我想贡献

法律通知

在为该项目做出贡献时，您必须同意您已经撰写了100％的内容，您拥有内容的必要权利，并且可以根据项目许可提供您贡献的内容。

报告错误

提交错误报告之前

一个好的错误报告不应该让其他人需要追逐您以获取更多信息。因此，我们要求您仔细调查，收集信息并详细描述您的报告中的问题。请提前完成以下步骤，以帮助我们尽快解决任何潜在的错误。

• 确保您正在使用最新版本。
• 确定您的错误是否真的是一个错误，而不是使用不兼容的环境组件/版本（请确保您已经阅读了文档。如果您正在寻找支持，则可能需要检查本节）。
• 要查看其他用户是否遇到过（可能已经解决）与您遇到的相同问题，请检查是否尚未在错误跟踪器中存在错误或错误的错误报告。
• 另外，请确保搜索Internet（包括堆栈溢出），以查看GitHub社区外的用户是否讨论了该问题。
• 收集有关该错误的信息：
• 堆栈跟踪（追溯）
• 操作系统，平台和版本（Windows，Linux，MacOS，X86，ARM）
• 解释器，编译器，SDK，运行时环境，软件包管理器的版本，具体取决于似乎相关的内容。
• 可能是您的输入和输出
• 您可以可靠地重现这个问题吗？您还可以用较旧版本复制它吗？

如何提交一个好的错误报告？

您绝对不能向问题跟踪器或公共场所举报有关安全问题，漏洞或错误，包括敏感信息。相反，敏感的错误必须通过电子邮件发送到<>。

我们使用GitHub问题来跟踪错误和错误。如果您遇到了该项目的问题：

• 打开一个问题。 （由于我们目前无法确定是否是错误，我们要求您不要谈论错误，也不要标记问题。）
• 解释您期望的行为和实际行为。
• 请提供尽可能多的上下文，并描述别人可以遵循的复制步骤，以自行重新创建问题。这通常包括您的代码。对于好的错误报告，您应该隔离问题并创建减少的测试用例。
• 提供您在上一节中收集的信息。

提交后：

• 项目团队将相应地标记该问题。
• 团队成员将尝试通过您提供的步骤重现问题。如果没有复制步骤或没有明显的方法来复制问题，则团队将要求您执行这些步骤，并将问题标记为needs-repro 。在复制之前，将不会解决带有needs-repro标签的错误。
• 如果团队能够复制该问题，则将标记为needs-fix以及其他标签（例如critical ），并且该问题将由某人实施。

建议增强

本节指导您提交有关贡献的增强建议，包括全新功能和对现有功能的较小改进。遵循这些准则将帮助维护者和社区了解您的建议并找到相关的建议。

提交增强之前

• 确保您正在使用最新版本。
• 仔细阅读文档，找出是否已经涵盖了该功能，也许是通过单个配置。
• 执行搜索以查看是否已经提出了增强。如果有的话，请在现有问题中添加评论，而不是打开新问题。
• 找出您的想法是否适合项目的范围和目标。您有坚定的理由说服该项目的开发人员此功能的优点。请记住，我们想要对大多数用户有用的功能，而不仅仅是一个小子集。如果您只是针对少数用户，请考虑编写附加/插件库。

我如何提交良好的增强建议？

增强建议被跟踪为GitHub问题。

• 使用明确的描述性标题来确定该建议。
• 在尽可能多的细节中提供建议增强的逐步描述。
• 描述当前的行为，并说明您期望看到的哪些行为以及原因。在这一点上，您还可以判断哪种替代方案对您不起作用。
• 您可能需要包括屏幕截图和动画GIF ，以帮助您演示该步骤或指出建议与之相关的部分。您可以使用此工具在MacOS和Windows上记录GIF，以及该工具或Linux上的该工具。
• 解释为什么这种增强对大多数贡献的md用户很有用。您可能还想指出其他可以更好地解决它并且可以作为灵感的项目。