doc: documentation update

Author: Gilles Grousset

CONTRIBUTING.md

@@ -85,5 +85,29 @@ Remediation time? (in minutes)
 
 ## Releasing
 
-TODO
+### Snapshots
+
+Every push to `develop` branch updates the matching snapshot release.
+
+For example: if project version is set to `0.1-SNAPSHOT` on`develop`. A `0.1-SNAPSHOT` will be released (or release will be updated if it already exists) as soon as the `maven.yml` GitHub actions workflow finishes.
+
+### Stable
+
+A new stable release is pushed on GitHub, on every new tag creation (performed by the `release.yml` GitHub Actions workflow).
+
+The steps to issue a new stable release are:
+1. Merge `develop` branch to `main`branch (do not squash in order to keep commit history).
+2. Create a new tag from `main` branch with a naming matching the release number. Example:
+```bash
+$ git tag -a 0.1.0
+```
+3. Push the new tag with:
+```bash
+$ git push --tags
+```
+
+Once released, remember to update the project version on the `develop`branch to a new snapshot number:
+```bash
+$ mvn versions:set -DnewVersion=0.2-SNAPSHOT
+``` 
 

README.md

@@ -185,20 +185,22 @@ You may follow and upvote these related issue if interested:
 
 All options are configurable in the SonarQube UI, via `sonar-project.properties` or `-D` parameters.
 
-|Name|Options|Default|Description
-|---|---|---|---|
-|`sonar.dart.analyzer.mode`|<code>DETECT&#124;DART&#124;FLUTTER&#124;MANUAL&#124;DARTANALYZER</code>|`DETECT`|By default the plugin attempts to detect a fitting analyzer (`flutter analyze` or `dart analyze`) by parsing the `environment` from `pubspec.yaml`. This can be set to `MANUAL` to provide and existing report file. For compatibility with older Dart versions, this can be set to `DARTANALYZER`.|
-|`sonar.dart.analyzer.options.override`|<code>true&#124;false</code>|`true`|By default any local `analysis_options.yaml` will be replaced for the analysis. This can be prevented by setting this to `false`.
-|`sonar.dart.analyzer.report.mode`|<code>DETECT&#124;MACHINE&#124;LEGACY</code>|`DETECT`|The new machine readable output can be automatically detected if Dart SDK is available on the $PATH.|
-|`sonar.dart.analyzer.report.path`|A file path|-|This is required if the analyzer mode is set to `MANUAL`.|
-|`sonar.flutter.tests.reportPath`|A file path|-|The path to the test report JSON file.|
-|`sonar.flutter.coverage.reportPath`|A file path|-|The path to the test coverage file in LCOV format.|
+| Name                                   | Options                                                                  | Default  | Description                                                                                                                                                                                                                                                                                         |
+|----------------------------------------|--------------------------------------------------------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `sonar.dart.analyzer.mode`             | <code>DETECT&#124;DART&#124;FLUTTER&#124;MANUAL&#124;DARTANALYZER</code> | `DETECT` | By default the plugin attempts to detect a fitting analyzer (`flutter analyze` or `dart analyze`) by parsing the `environment` from `pubspec.yaml`. This can be set to `MANUAL` to provide and existing report file. For compatibility with older Dart versions, this can be set to `DARTANALYZER`. |
+| `sonar.dart.analyzer.options.override` | <code>true&#124;false</code>                                             | `true`   | By default any local `analysis_options.yaml` will be replaced for the analysis. This can be prevented by setting this to `false`.                                                                                                                                                                   |
+| `sonar.dart.analyzer.report.mode`      | <code>DETECT&#124;MACHINE&#124;LEGACY</code>                             | `DETECT` | The new machine readable output can be automatically detected if Dart SDK is available on the $PATH.                                                                                                                                                                                                |
+| `sonar.dart.analyzer.report.path`      | A file path                                                              | -        | This is required if the analyzer mode is set to `MANUAL`.                                                                                                                                                                                                                                           |
+| `sonar.flutter.tests.reportPath`       | A file path                                                              | -        | The path to the test report JSON file.                                                                                                                                                                                                                                                              |
+| `sonar.flutter.coverage.reportPath`    | A file path                                                              | -        | The path to the test coverage file in LCOV format.                                                                                                                                                                                                                                                  |
 
 
 ## Contributing
 
 Any help is welcome, and PRs will be greatly appreciated!
 
+Please read [CONTRIBUTING](https://github.com/insideapp-oss/sonar-flutter/blob/develop/CONTRIBUTING.md) for more information.
+
 
 ## License