CONTRIBUTING.en-US.md

Tencent Cloud Monitor Grafana App Contribution Guide

Become a contributor

Thanks for your passionate for becoming one of our contributors!

You can choose the following contribution methods:

• Contribute Dashboard Templates
• Contribute your amazing code and create a Pull Request
• Report bug(s) and create an Issue

We will add you into our contributor list

Local Development

1. Environment preparation

• Docker
• Magefile >= 1.11
• Go >=1.16
• Node.js >= 14

2. Fork this project to your own git account and clone:

$ git clone https://github.com/${your-git-username}/tencentcloud-monitor-grafana-app.git

2. Install dependencies:

$ npm install
$ go mod vendor

3. Start frontend development environment:

$ npm run watch

4. Start backend development environment

$ mage -v

5. Run in your command line:

$ docker-compose up

Then visit (http://localhost:3000).

6. After making some amazing changes, create a Pull Request and we will review your contribution!

Commit Message Format

We follow Converntional Commit message guidelines as shown below:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Each commit message consists of a header, a body and a footer. The header is mandatory and the scope of the header is optional.

Any line of the commit message cannot be longer 100 characters!

type can be one of the followings:

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