Community readiness improvements (#781)

* Create code-of-conduct.md * Update README.md Co-authored-by: PaulJacobs-percona <[email protected]>
percona · Oct 5, 2021 · b483c48 · b483c48
1 parent a3a8d2d
commit b483c48
Show file tree

Hide file tree

Showing 4 changed files with 59 additions and 2 deletions.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -1,3 +1,42 @@
+# Welcome to PMM!
+
+We're glad that you would like to become a Percona community member and participate in keeping open source open.
+
+
+## Prerequisites
+
+Before submitting code or 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](https://cla-assistant.percona.com/percona/pmm) (CLA). You can do this using your GitHub account and one click.
+
+### 2. Code of Conduct
+
+Please make sure to read and agree to our [Code of Conduct](https://github.com/percona/pmm/blob/main/code-of-conduct.md).
+
+## Submitting Bug Reports
+
+If you find a bug in Percona Monitoring and Management  or one of the related projects, you should submit a report to that project's [JIRA](https://jira.percona.com) issue tracker.
+
+Your first step should be [to search](https://jira.percona.com/issues/?jql=project=PMM) 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.](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=11600&issuetype=1&priority=3)
+3. Fill in the fields of *Summary*, *Description*, *Steps To Reproduce*, and *Affects Version* 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.](http://fantasai.inkedblade.net/style/talks/filing-good-bugs/).
+
+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.
+
+
+
 # Contributing notes
 
 ## Pre-requirements

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
diff --git a/README.md b/README.md
@@ -5,7 +5,19 @@
 
 ![PMM](https://www.percona.com/sites/default/files/pmm-logo.png)
 
-See the [PMM 2.x docs](https://www.percona.com/doc/percona-monitoring-and-management/2.x/index.html) for more information.
+
+## Percona Monitoring and Management
+
+A 'single pane of glass' to easily view and monitor the performance of your MySQL, MongoDB, PostgreSQL, and MariaDB databases.
+
+[Percona Monitoring and Management (PMM)](https://www.percona.com/software/database-tools/percona-monitoring-and-management) is a best-of-breed open source database monitoring solution. It helps you reduce complexity, optimize performance, and improve the security of your business-critical database environments, no matter where they are located or deployed.
+PMM helps users to:
+* Reduce Complexity
+* Optimize Database Performance
+* Improve Data Security
+
+
+See the [PMM Documentation](https://www.percona.com/doc/percona-monitoring-and-management/2.x/index.html) for more information.
 
 ## Submitting Bug Reports
 

diff --git a/code-of-conduct.md b/code-of-conduct.md
@@ -0,0 +1,7 @@
+# Percona Percona Helm Charts 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.
+
+