Skip to content

Latest commit

 

History

History
87 lines (55 loc) · 2.8 KB

CONTRIBUTING.md

File metadata and controls

87 lines (55 loc) · 2.8 KB
Raw

Contributing notes

We're looking forward to the new contributors.

Our experts must verify all contributions from contributors.

We'd love it if you could contribute a new dashboard or a panel or improve existing ones.

We can help you, more information on the link

Local setup

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:
      - DISABLE_TELEMETRY=1
    volumes:
      - ./dist:/var/lib/grafana/plugins/pmm-app/dist
    ports:
      - 80:80
    restart: always

Then to run it:

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

Workflow for the contributor

  1. Find the task in JIRA or 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. Switch the repository to the correct branch. Now it's PMM-2.0.

  5. Create a new branch for your task. Name it using the following pattern: [JIRA_ISSUE_ID]-[username]-[short_title]. For example: PMM-5053-dbazhenov-tooltip .

  6. Make changes to the code in your branch.

  7. 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"

  8. Run the tests with npm run test and make sure all the tests pass.

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

    git push origin PMM-5053-dbazhenov-tooltip

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

    Example: from dbazhenov:PMM-5053-dbazhenov-tooltip to percona:PMM-2.0

  11. 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.

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

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

  14. Congratulations, you have become a contributor. Thanks for contributing to open source!