Skip to content

Latest commit

 

History

History
127 lines (80 loc) · 5.22 KB

CONTRIBUTING.md

File metadata and controls

127 lines (80 loc) · 5.22 KB
Raw

Welcome to the repository hosting grafana dashboards for PMM!

We encourage contributions and are always looking for new members that are as dedicated to serving the community as we are.

You can also reach us on our Forums and Discord.

Prerequisites

Before submitting code or documentation contributions, you should first complete the following prerequisites.

Sign the CLA

Before you can contribute, we kindly ask you to sign our Contributor License Agreement (CLA). You can do this using your GitHub account and one click.

Submitting a Bug

If you find a bug in Percona MongoDB Exporter or one of the related projects, you should submit a report to that project's JIRA issue tracker.

Your first step should be to search the existing set of open tickets for a similar report. If you find that someone else has already reported your problem, then you can upvote that report to increase its visibility.

If there is no existing report, submit a report following these steps:

  1. Sign in to Percona JIRA. You will need to create an account if you do not have one.
  2. Go to the Create Issue screen and select the relevant project.
  3. Fill in the fields of Summary, Description, Steps To Reproduce, and Affects Version to the best you can. If the bug corresponds to a crash, attach the stack trace from the logs.

An excellent resource is Elika Etemad's article on filing good bug reports..

As a general rule of thumb, please try to create bug reports that are:

  • Reproducible. Include steps to reproduce the problem.
  • Specific. Include as much detail as possible: which version, what environment, etc.
  • Unique. Do not duplicate existing tickets.
  • Scoped to a Single Bug. One bug per report.

Setup your local development environment

The easiest way to setup a development environment is to use Docker Compose. That environment bundles a number of tools to help you populate the panels with sample data.

cd pmm-app
docker-compose up -d
npm run dev

For a much simpler development environment you could create a local file docker-compose.local.yml inside of pmm-app folder:

version: "3"
services:
  pmm-server:
    container_name: pmm-server
    image: percona/pmm-server:2
    environment:
      - ENABLE_DBAAS=1
      - ENABLE_BACKUP_MANAGEMENT=1
      - ENABLE_ALERTING=1
    volumes:
      - ./dist:/srv/grafana/plugins/pmm-app/dist
    ports:
      - 80:80
    restart: always

Please note, that we map the ./pmm-app/dist folder as a subfolder of /var/lib/grafana/plugins so that front-end artifacts, i.e. panels and dashboards, can be picked up by grafana server running in the docker container.

Then to run it:

cd pmm-app
docker-compose -f ./docker-compose.local.yml up -d
npm run dev

Submitting a Pull Request

  1. Find the task in JIRA or issue here in github. If no a similar task is found, please create a new task. Use a component filter Grafana Dashboards.

  2. You need to make a fork of our repository in your GitHub account.

  3. Make a clone of your repository on your computer.

  4. Create a new branch for your task. We recommend as a best practice to mention an issue number or just short desc in a branch name.

    Example:

    PMM-5053-add-missed-tooltips

  5. Make changes to the code in your branch.

  6. Make a commit. It is essential to provide a meaningfull description. Use the following formula: "[JIRA_ISSUE_ID] What is being done."

    Example:

    git add .
git commit -m "PMM-5053 Add a tooltip for Head Block widget for Prometheus Dashboard"

  7. Push your branch into your repository. Check that your branch only contains code relevant to the issue.

    Example:

    git push origin PMM-5053-dbazhenov-tooltip

  8. Make a Pull Request from your branch to the right branch in percona/grafana-dashboards.

    Example:

    from dbazhenov:PMM-5053-dbazhenov-tooltip to percona:main

Code Reviews

  1. After submitting your PR please add pmm-review-fe team as a reviewer - that would auto assign reviewers to review your PR.

  2. Your Pull Request must pass certain checks, i.e. Jenkins CI, and Contributor License Agreement. You need to open the Contributor License Agreement page, read it, and confirm it.

  3. Wait for our experts to review your code. You may need to answer questions or to address requests for changes.

  4. Our Engineers will merge your branch into the release branch by themselves.

After your Pull Request is merged

Once your pull request is merged, you are an official Percona Community Contributor. Welcome to the community!

We're looking forward to your contributions and hope to hear from you soon on our Forums and Discord.