diff options
| author | Julien HENRY <julien.henry@sonarsource.com> | 2019-04-04 17:10:33 +0200 |
|---|---|---|
| committer | Julien HENRY <julien.henry@sonarsource.com> | 2019-04-04 18:53:50 +0200 |
| commit | 0d2614571c70622fc69eb14f9c07518cfd8f5f8c (patch) | |
| tree | 8de792153b2713e013921eab5a8027b2c6a63040 /docs | |
| parent | f65ad9175338b374a0bde05313e7f76914549b75 (diff) | |
| download | sonar-scanner-cli-0d2614571c70622fc69eb14f9c07518cfd8f5f8c.tar.gz sonar-scanner-cli-0d2614571c70622fc69eb14f9c07518cfd8f5f8c.zip | |
Add contributing guide
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/PULL_REQUEST_TEMPLATE.md | 8 | ||||
| -rw-r--r-- | docs/contributing.md | 12 |
2 files changed, 20 insertions, 0 deletions
diff --git a/docs/PULL_REQUEST_TEMPLATE.md b/docs/PULL_REQUEST_TEMPLATE.md new file mode 100644 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 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 |