Add contributing guide

diff --git a/README.md b/README.md
index 1a385906106ac74cb0a570d02d912deb6c923ed5..aa85b2a01a97337cc22ca8fd289f8d643827282d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,17 +1,37 @@
 SonarQube Scanner 
 =========================
+Official SonarQube Scanner used to start code analysis. Project configuration is read from file `sonar-project.properties` or passed on command line.
+
 [![Build Status](https://travis-ci.org/SonarSource/sonar-scanner-cli.svg?branch=master)](https://travis-ci.org/SonarSource/sonar-scanner-cli)
 [![Build status](https://ci.appveyor.com/api/projects/status/s3sg3fhui556v02o/branch/master?svg=true)](https://ci.appveyor.com/project/henryju/sonar-scanner-cli/branch/master) [![Quality Gate Status](https://next.sonarqube.com/sonarqube/api/project_badges/measure?project=org.sonarsource.scanner.cli%3Asonar-scanner-cli&metric=alert_status)](https://next.sonarqube.com/sonarqube/dashboard?id=org.sonarsource.scanner.cli%3Asonar-scanner-cli)
 
-Official SonarQube Scanner used to start code analysis. Project configuration is read from file `sonar-project.properties` or passed on command line.
-
 Documentation
-http://docs.sonarqube.org/display/SCAN/Analyzing+with+SonarQube+Scanner
+-------------
+
+https://redirect.sonarsource.com/doc/install-configure-scanner.html
+
+Have Question or Feedback?
+--------------------------
+
+For support questions ("How do I?", "I got this error, why?", ...), please head to the [SonarSource forum](https://community.sonarsource.com/c/help). There are chances that a question similar to yours has already been answered. 
+
+Be aware that this forum is a community, so the standard pleasantries ("Hi", "Thanks", ...) are expected. And if you don't get an answer to your thread, you should sit on your hands for at least three days before bumping it. Operators are not standing by. :-)
+
+
+Contributing
+------------
+
+If you would like to see a new feature, please create a new thread in the forum ["Suggest new features"](https://community.sonarsource.com/c/suggestions/features).
+
+Please be aware that we are not actively looking for feature contributions. The truth is that it's extremely difficult for someone outside SonarSource to comply with our roadmap and expectations. Therefore, we typically only accept minor cosmetic changes and typo fixes.
+
+With that in mind, if you would like to submit a code contribution, please create a pull request for this repository. Please explain your motives to contribute this change: what problem you are trying to fix, what improvement you are trying to make.
+
+Make sure that you follow our [code style](https://github.com/SonarSource/sonar-developer-toolset#code-style) and all tests are passing (Travis build is executed for each pull request).
 
-Issue Tracker:
-http://jira.sonarsource.com/browse/SQSCANNER
 
-### License
+License
+-------
 
 Copyright 2011-2019 SonarSource.
 

diff --git a/docs/PULL_REQUEST_TEMPLATE.md b/docs/PULL_REQUEST_TEMPLATE.md
new file mode 100644 (file)
index 0000000..afe4fae
--- /dev/null
+++ b/docs/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,8 @@
+Please review our [contribution guidelines](https://github.com/SonarSource/sonar-scanner-cli/blob/master/contributing.md).
+
+And please ensure your pull request adheres to the following guidelines: 
+
+- [ ] Please explain your motives to contribute this change: what problem you are trying to fix, what improvement you are trying to make
+- [ ] Use the following formatting style: [SonarSource/sonar-developer-toolset](https://github.com/SonarSource/sonar-developer-toolset#code-style)
+- [ ] Provide a unit test for any code you changed
+- [ ] If there is a [JIRA](https://jira.sonarsource.com/browse/SQSCANNER) ticket available, please make your commits and pull request start with the ticket ID (SQSCANNER-XXXX)

diff --git a/docs/contributing.md b/docs/contributing.md
new file mode 100644 (file)
index 0000000..0cde8f6
--- /dev/null
+++ b/docs/contributing.md
@@ -0,0 +1,12 @@
+Contributing
+============
+
+If you would like to see a new feature, please create a new thread in the forum ["Suggest new features"](https://community.sonarsource.com/c/suggestions/features).
+
+Please be aware that we are not actively looking for feature contributions. The truth is that it's extremely difficult for someone outside SonarSource to comply with our roadmap and expectations. Therefore, we typically only accept minor cosmetic changes and typo fixes.
+
+With that in mind, if you would like to submit a code contribution, please create a pull request for this repository. Please explain your motives to contribute this change: what problem you are trying to fix, what improvement you are trying to make.
+
+Make sure that you follow our [code style](https://github.com/SonarSource/sonar-developer-toolset#code-style) and all tests are passing (Travis build is executed for each pull request).
+
+Thank You! The SonarSource Team