Skip to content

Commit 7cf88f9

Browse files
committed
Add contributing guide
1 parent a0faa92 commit 7cf88f9

3 files changed

Lines changed: 46 additions & 6 deletions

File tree

README.md

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,33 @@
1-
SonarQube Scanner API [![Build Status](https://travis-ci.org/SonarSource/sonar-scanner-api.svg?branch=master)](https://travis-ci.org/SonarSource/sonar-scanner-api)
2-
=========================
1+
SonarQube Scanner API
2+
=====================
33

44
Common library used by many Scanners (SQ Scanner, SQ Scanner for Maven, SQ Scanner for Gradle, SQ Scanner for Ant, ...). Used to programmatically run SQ analysis.
55

6-
Issue Tracker:
7-
https://jira.sonarsource.com/browse/SCANNERAPI
6+
[![Build Status](https://travis-ci.org/SonarSource/sonar-scanner-api.svg?branch=master)](https://travis-ci.org/SonarSource/sonar-scanner-api)
7+
8+
Have Question or Feedback?
9+
--------------------------
10+
11+
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.
12+
13+
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. :-)
14+
15+
16+
Contributing
17+
------------
18+
19+
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).
20+
21+
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.
22+
23+
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.
24+
25+
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).
26+
827

9-
### License
28+
License
29+
-------
1030

11-
Copyright 2011-2017 SonarSource.
31+
Copyright 2011-2019 SonarSource.
1232

1333
Licensed under the [GNU Lesser General Public License, Version 3.0](http://www.gnu.org/licenses/lgpl.txt)

docs/PULL_REQUEST_TEMPLATE.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Please review our [contribution guidelines](https://github.com/SonarSource/sonar-scanner-api/blob/master/contributing.md).
2+
3+
And please ensure your pull request adheres to the following guidelines:
4+
5+
- [ ] Please explain your motives to contribute this change: what problem you are trying to fix, what improvement you are trying to make
6+
- [ ] Use the following formatting style: [SonarSource/sonar-developer-toolset](https://github.com/SonarSource/sonar-developer-toolset#code-style)
7+
- [ ] Provide a unit test for any code you changed
8+
- [ ] If there is a [JIRA](https://jira.sonarsource.com/browse/SCANNERAPI) ticket available, please make your commits and pull request start with the ticket ID (SCANNERAPI-XXXX)

docs/contributing.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Contributing
2+
============
3+
4+
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).
5+
6+
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.
7+
8+
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.
9+
10+
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).
11+
12+
Thank You! The SonarSource Team

0 commit comments

Comments
 (0)