Skip to content

Latest commit

 

History

History
56 lines (37 loc) · 2.18 KB

CONTRIBUTING.md

File metadata and controls

56 lines (37 loc) · 2.18 KB

贡献指南

引言

首先,感谢您考虑为 graphin 做出贡献!正是像您这样的人才让开源社区成为一个学习、启发和创造的绝佳场所。本文档提供了对 graphin 做出贡献的指导原则。请遵守这些指南,以帮助维护一个协作和包容的环境。

贡献方式

您可以通过多种方式为 graphin 做出贡献:

  • 报告错误:如果您发现一个错误,请检查问题跟踪器,看看它是否已经被报告过。如果没有,请开设一个新的问题。确保包含一个清晰的标题、详细的描述以及尽可能多的相关信息。
  • 建议增强功能:新想法总是受欢迎的。开设一个问题以建议改进或新增功能。
  • 编写文档:良好的文档和代码本身一样重要。如果您喜欢写作并希望帮忙,请考虑改善文档。
  • 提交拉取请求(Pull Requests):拉取请求对我们保持持续进步至关重要。无论您是在修复一个错误、实现一个功能还是改进文档,每一份贡献都是宝贵的。

开始之前

在开始贡献之前,请确保:

  1. Fork 仓库并从 v3 分支创建您自己的分支。
  2. 如果您添加代码,请添加覆盖新功能/错误修复的测试。
  3. 确保本地测试套件通过。
  4. 如果您更改了 API,请更新文档。
  5. 确保您的代码遵循规范。
  6. 为您的提交写一个清晰的日志消息。对于小的更改,一行消息就足够了,但更大的更改应包括更多的细节。

拉取请求流程

  1. 确保您的代码符合项目的编码规范(缩进、准确的注释等),并且您的所有提交都已签名。
  2. 如果有对项目至关重要的更改,请更新 README.md。
  3. 将任何示例文件和 README.md 中的版本号增加到这个拉取请求所代表的新版本。
  4. 一旦您得到两个其他开发者的签署,您可以合并拉取请求,如果您没有权限这样做,您可以请求第二个审阅者为您合并。

启动项目

  • 安装依赖:
$ pnpm install
  • 调试 DEMO
$ cd packages/graphin

$ npm run dev
  • 运行单元测试和构建
$ cd packages/graphin

$ npm run build