Skip to content

Latest commit

 

History

History
66 lines (42 loc) · 3.39 KB

CONTRIBUTING.md

File metadata and controls

66 lines (42 loc) · 3.39 KB
Raw

宁愿一年不将军，不可一日不拱卒

当为npm工具包编写贡献指南（CONTRIBUTING.md）时，您需要提供清晰的说明，让其他开发者了解如何参与贡献并保持代码库的一致性和质量。以下是一个简单的模板，您可以根据自己的项目需求进行定制：

项目名称贡献指南

欢迎您对项目名称做出贡献！我们很高兴接受来自开发者社区的问题报告、建议和代码贡献。在参与贡献之前，请阅读以下指南，以确保您的贡献顺利进行。

提交问题

如果您在使用项目时遇到了问题或者发现了 bug，请提交一个 issue 来告知我们。在提交问题之前，请确保搜索已有的 issue，以避免重复。您可以按照以下步骤提交问题：

  1. 确保您在最新的代码版本下遇到了问题。
  2. 进入项目的 Issue 页面 并点击 "New Issue" 按钮。
  3. 填写问题报告模板，提供尽可能详细的信息，以便我们能够重现并修复问题。

贡献代码

我们非常欢迎开发者对项目提交代码贡献。在提交代码之前，请确保您已经阅读了以下几点：

  1. 确保您的代码符合项目的编码规范和风格指南。
  2. 在每个提交中提供清晰明了的提交信息，描述您所做的更改。
  3. 当您的代码解决了某个已有的 issue 时，请在提交信息中引用该 issue 编号（例如：#42）。
  4. 在提交代码之前，确保您已经运行了所有的测试，并通过了测试用例。

分支管理

我们使用 Git 进行代码版本管理。主要的分支包括：

  • main: 主分支，用于发布稳定版本。
  • develop: 开发分支，包含最新的开发代码。

请确保您的代码贡献是基于 develop 分支创建的。

提交代码

为了提交代码贡献，请按照以下步骤操作：

  1. Fork 本项目至您的 GitHub 账号下。
  2. 在您的本地环境中，从 develop 分支创建一个新的特性分支： 
    git checkout -b feature/your-feature-name develop
  3. 提交您的更改，并推送到您的 GitHub 仓库： 
    git add .
git commit -m "描述您的更改"
git push origin feature/your-feature-name
  4. 在 GitHub 页面中创建一个 Pull Request，将您的更改提交到项目的 develop 分支。请提供清晰的描述和参考相关的 issue 编号。

讨论和反馈

我们欢迎所有对项目感兴趣的开发者加入到讨论中来。您可以参与 GitHub 的 issue 讨论，或者加入我们的社区（例如 Gitter、Slack 等）。在参与讨论时，请遵守我们的行为准则，尊重他人，并保持友好的沟通氛围。

行为准则

为了维护一个友好、专业的开发者社区，我们要求所有参与者遵守行为准则。请在任何社区交互中尊重他人，并避免使用攻击性语言或行为。

版权和许可

在贡献代码之前，请确保您已经阅读并同意项目的许可协议。通过对项目提交代码，您表示您同意授予项目所有者相应的许可权利。

请注意，以上只是一个简单的贡献指南模板，您可以根据实际项目需求进行修改和补充。同时，确保提供项目的具体链接、讨论渠道以及版权和许可信息。这样，其他开发者就能更好地了解项目，积极参与贡献，并遵守项目的规则和准则。