Skip to content

Latest commit

 

History

History
83 lines (59 loc) · 1.9 KB

CONTRIBUTING.md

File metadata and controls

83 lines (59 loc) · 1.9 KB

腾讯云监控插件@Grafana 开发贡献指南

成为贡献者

感谢您有兴趣成为 腾讯云监控插件@Grafana 社区贡献者!

您可以选择如下的贡献方式:

我们会将您加入 我们的贡献者名单

本地开发

  1. 环境准备
  1. Fork 此项目后克隆到本地:
$ git clone https://github.com/${your-git-username}/tencentcloud-monitor-grafana-app.git
  1. 安装依赖:
$ npm install
$ go mod vendor
  1. 启动前端开发环境:
$ npm run watch
  1. 启动后端开发环境:
$ mage -v
  1. 在命令行中运行:
$ docker-compose up

然后访问 (http://localhost:3000)。

  1. 开发完成后通过 Pull Request 的方法提交代码请求合并。

提交代码规范

遵循 Converntional 提交信息规范

提交格式如下:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

每次提交可以包含页眉(header)、正文(body)和页脚(footer),每次提交必须包含页眉内容

每次提交的信息不超过100个字符

type 可为如下选择之一:

  • build
  • ci
  • chore
  • docs
  • feat
  • fix
  • perf
  • refactor
  • revert
  • style
  • test