Skip to content

Latest commit

 

History

History
61 lines (36 loc) · 3.94 KB

CONTRIBUTING.md

File metadata and controls

61 lines (36 loc) · 3.94 KB
Raw

Contributing to Percona Operator for MySQL documentation

This repository contains the source file for Percona Operator for MySQL documentation and this document explains how you can contribute to it.

If you'd like to submit a code patch, follow the Contributing guide in the Operator code repository.

Prerequisites

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

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

2. Code of Conduct

Please make sure to read and observe the Contribution Policy.

Submitting a pull request

1. Making a bug report

Improvement and bugfix tasks for the Operator are tracked in Jira. Although not mandatory, it is a good practice to examine already open Jira issues before submitting a pull request. For bigger contributions, we suggest creating a Jira issue first and discussing it with the engineering team and community before proposing any code changes.

Another good place to discuss Percona Operator for MySQL 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 K8SPS-22.

    Create the branch in your local repo as follows:

    git checkout -b K8SPS-22-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 "K8SPS-22 fixed by ......"
git push -u origin K8SPS-22-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 how to modify your code to better match the project’s expectations.