Skip to content

IoT-Hub-Node 贡献指南

欢迎您对本开源项目进行贡献!我们非常感谢您的支持和参与。在提交贡献之前,请确保您已经阅读并理解以下内容。

报告问题

如果您在使用本项目时遇到任何问题,请您通过 GitHub Issues 来报告,我们将尽快跟进和解决。

如何贡献

在开始贡献之前,请先 Fork 本项目。 创建一个新的分支来进行您的修改:git checkout -b feature/your-feature 执行相应的更改和改进。 提交您的更改:git commit -m 'Add some feature' 将您的更改推送到您的分支:git push origin feature/your-feature 提交 Pull Request,我们将会审查您的更改并合并到项目主干。 请注意,我们鼓励遵循适当的代码风格、编码规范以及提交详细和清晰的描述。

开发环境设置

在开始开发之前,请确保您已经完成以下设置和准备工作:

安装所需的依赖项:npm install 配置开发环境:...

提交指南

在提交之前,请确保您的代码通过了项目的测试。 请确保您的提交消息清晰明了,提供对更改的简要描述。 如果适用,请在提交消息中引用关联的问题或 Pull Request 编号。

commit message格式

参考阿里云代码规范

[类型](说明 commit 影响的范围): commit目的的简短描述,不超过50个字符(必须)

类型:

  • feat: 新功能
  • fix: 修复问题
  • docs: 修改文档
  • style: 修改代码格式,不影响代码逻辑
  • refactor: 重构代码,理论上不影响现有功能
  • perf: 提升性能
  • test: 增加修改测试用例
  • chore: 修改工具相关(包括但不限于文档、代码生成等)
  • deps: 升级依赖
  • revert: 回滚操作

影响范围: 比如数据层、控制层、视图层等等

描述: 对本次 commit 的简短描述,不超过50个字符 结尾不加句号或其他标点符号。

示例

fix(user):修复用户登录时的bug

版权和许可

请注意,通过贡献您的代码,您默认同意将其版权授予本项目,并且您的贡献将遵循项目的许可证。