Browse Source

Add contributing guide, revise related docs

tags/7.8
Janos Gyerik 5 years ago
parent
commit
cc6b7650d1
3 changed files with 20 additions and 6 deletions
  1. 4
    5
      README.md
  2. 3
    1
      docs/PULL_REQUEST_TEMPLATE.md
  3. 13
    0
      docs/contributing.md

+ 4
- 5
README.md View File

@@ -27,14 +27,13 @@ Be aware that this forum is a community, so the standard pleasantries ("Hi", "Th
Contributing
------------

### Pull Request
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 create a new thread in the forum ["Suggest new features"](https://community.sonarsource.com/c/suggestions/features) when contributing a new feature. You have to be sure that the feature complies with our roadmap and expectations.
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.

To submit a code contribution, create a pull request for this repository. Please explain your motives to contribute this change (if it's not a new feature): 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](#testing) are passing (Travis build is executed for each 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).

Building
--------

PULL_REQUEST_TEMPLATE.md → docs/PULL_REQUEST_TEMPLATE.md View File

@@ -1,4 +1,6 @@
Please ensure your pull request adheres to the following guidelines:
Please review our [contribution guidelines](https://github.com/SonarSource/sonarqube/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)

+ 13
- 0
docs/contributing.md View File

@@ -0,0 +1,13 @@
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

Loading…
Cancel
Save