aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorlukasz-jarocki-sonarsource <77498856+lukasz-jarocki-sonarsource@users.noreply.github.com>2021-06-25 14:54:14 +0200
committerGitHub <noreply@github.com>2021-06-25 14:54:14 +0200
commitfdad4d48ef3d2ef15c48effd841befab5b11f0d3 (patch)
tree20b05d143661d53e6d90344433d67f4a0fd2bf1c
parent14f802df6825a3ee04e155934916dfda75218ee7 (diff)
downloadsonar-scanner-cli-fdad4d48ef3d2ef15c48effd841befab5b11f0d3.tar.gz
sonar-scanner-cli-fdad4d48ef3d2ef15c48effd841befab5b11f0d3.zip
Updating contributing md (#115)
-rw-r--r--contributing.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/contributing.md b/contributing.md
new file mode 100644
index 0000000..0fcc4d4
--- /dev/null
+++ b/contributing.md
@@ -0,0 +1,26 @@
+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.
+
+## Submitting a pull request
+
+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).
+
+## Next steps
+
+One of the members of our team will carefully review your pull request. You might be asked at this point for clarifications or your pull request might be rejected if we decide that it doesn't fit our roadmap and vision for the product.
+If your contribution looks promising then either we will decide:
+
+- it is good to go and merge your pull request to the master branch
+
+or
+
+- that we need to think over your change and modify it to adhere to our roadmap and internal standards. We will close your pull request at this point, but we might come back to your changes later in the future when we decide it is the right time to work on it.
+
+Thank You!
+The SonarSource Team