Skip to content

Latest commit

 

History

History
53 lines (32 loc) · 3.31 KB

CONTRIBUTING.md

File metadata and controls

53 lines (32 loc) · 3.31 KB
Raw

Contributing to PMM Dump documentation

This repository contains the source file for PMM Dump documentation and this document explains how you can contribute to it.

Prerequisites

Please make sure to read and observe the Percona Community Code of Conduct..

Submitting a pull request

1. Making a bug report

Improvement and bugfix tasks for Percona's projects are tracked in Jira.

Although not mandatory, it is a good practice to examine already open Jira issues first. For bigger contributions, we suggest creating a Jira issue and discussing it with the engineering team and community before proposing any code changes.

Another good place to discuss Percona's projects with developers and other community members is the community forum.

2. Contributing to the source tree

Contributions to the source tree should follow the workflow described below:

  1. First, you need to fork the repository on GitHub, clone your fork locally, and then sync your local fork to upstream. After that, before starting to work on changes, make sure to always sync your fork with upstream.

  2. Create a branch for changes you are planning to make. If there is a Jira ticket related to your contribution, it is recommended to name your branch in the following way: <Jira issue number>-<short description>, where the issue number is something like K8SPG-42.

    Create the branch in your local repo as follows:

    $ git checkout -b SE-42-fix-feature-X

    When your changes are ready, make a commit, mentioning the Jira issue in the commit message, if any:

    $ git add .
$ git commit -m "SE-42 fixed by ......"
$ git push -u origin SE-42-fix-feature-X

  3. Create a pull request to the main repository on GitHub.

  4. When the reviewer makes some comments, address any feedback that comes and update the pull request.

  5. When your contribution is accepted, your pull request will be approved and merged to the main branch.

3. Contributing to documentation

Please take into account a few things:

  1. All documentation is written using the Markdown markup language. It allows easy publishing of various output formats such as HTML and PDF.
  2. We store the documentation as *.md files in the main branch of the repository and use MkDocs to convert Markdown files into a static HTML website or PDF. The documentation is licensed under the Attribution 4.0 International license (CC BY 4.0).

Code review

Your contribution will be reviewed by other developers contributing to the project. The more complex your changes are, the more experts will be involved. You will receive feedback and recommendations directly on your pull request on GitHub, so keep an eye on your submission and be prepared to make further amendments. The developers might even provide some concrete suggestions on modifying your code to match the project’s expectations better.