CLOUD-618 add contributing guide to docker images (#421)

* CLOUD-618 add contributing guide to docker images * Update README.md * Update README.md * update based on comments * minor clarification * fix the fork-a-repo link Co-authored-by: Sergey Pronin <[email protected]>
percona · Mar 19, 2021 · a53fd5e · a53fd5e
1 parent 629265a
commit a53fd5e
Show file tree

Hide file tree

Showing 3 changed files with 70 additions and 17 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,52 @@
+# Contributing to Docker Images Collection
+
+## Prerequisites
+
+Before submitting code 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](https://cla-assistant.percona.com/percona/percona-docker) (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](code-of-conduct.md).
+
+## Submitting a pull request
+
+### 1. Making a bug report
+
+Improvement and bugfix tasks for Percona's projects are tracked in Jira. If you find a bug in Percona Docker Images or one of the related projects, you should submit a report to that project's [Jira issue tracker](https://jira.percona.com).
+
+Although not mandatory, it is a good practice [to examine already open Jira issues](https://jira.percona.com/issues/?jql=project%20%3D%20%22Cloud%20Dev%22) 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](https://forums.percona.com).
+
+### 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](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo), clone your fork locally, and then [sync your local fork to upstream](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/syncing-a-fork). 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 `K8SPXC-622`.
+
+   Create the branch in your local repo as follows:
+
+   ```
+   git checkout -b K8SPXC-622-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 "K8SPXC-622 fixed by ......"
+   git push -u origin K8SPXC-622-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.
+
+## 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.
diff --git a/README.md b/README.md
@@ -1,26 +1,20 @@
-# Percona Docker Images Collection 
-[![CLA assistant](https://cla-assistant.percona.com/readme/badge/percona/percona-docker)](https://cla-assistant.percona.com/percona/percona-docker)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 
-Collection of Dockerfiles for Percona sofware.
-See individual directories for more details.
+# Percona Docker Images Collection
 
-## Submitting Bug Reports
+This repository contains a collection of Dockerfiles for Percona sofware. Dockerfiles can be used to customize and build docker images.
+Read more about Dockerfiles [here](https://docs.docker.com/engine/reference/builder/).
 
-If you find a bug in Percona Docker Images or one of the related projects, you should submit a report to that project's [JIRA](https://jira.percona.com) issue tracker.
+See individual directories for instructions on how to build and run Percona software.
 
-Your first step should be [to search](https://jira.percona.com/issues/?jql=project%20%3D%20%22Cloud%20Dev%22) 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.
+# Contributing
 
-If there is no existing report, submit a report following these steps:
+Percona welcomes and encourages community contributions to help improve our projects.
 
-1. [Sign in to Percona JIRA.](https://jira.percona.com/login.jsp) 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.](https://jira.percona.com/secure/CreateIssueDetails!init.jspa?pid=12500&issuetype=1&priority=3)
-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.
+See the [Contribution Guide](CONTRIBUTING.md) for more information.
 
-An excellent resource is [Elika Etemad's article on filing good bug reports.](http://fantasai.inkedblade.net/style/talks/filing-good-bugs/).
+## Submitting Bug Reports
 
-As a general rule of thumb, please try to create bug reports that are:
+If you find a bug in Percona Docker Images or one of the related projects, you should submit a report to that project's [Jira](https://jira.percona.com) issue tracker.
 
-- *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.
+Learn more about submitting bugs, new feature ideas, and improvements in the [Contribution Guide](CONTRIBUTING.md).
diff --git a/code-of-conduct.md b/code-of-conduct.md
@@ -0,0 +1,7 @@
+# Percona Docker Images Collection Code of Conduct
+
+All Percona Products follow the [Percona Community Code of Conduct](https://github.com/percona/community/blob/main/content/contribute/coc.md).
+
+If you notice any unacceptable behavior, let us know as soon as possible by writing to <[email protected]>. We will respond within 48 hours.
+
+