PYSCAN-59 Remove temporarily the For developers section of the documentation (#56)

Author: ghislainpiot

CONTRIBUTING.md

@@ -0,0 +1,84 @@
+# For developers
+
+## Prerequisites
+
+ - Python 3.12
+ - [pipx](https://github.com/pypa/pipx)
+
+## Install poetry
+
+Install poetry with `pipx install poetry`
+
+# Run the main script
+
+Run `python src/pysonar`
+
+# Run the tests
+
+Run `poetry install` to install the dependencies. By default, the dependencies are installed from the Jfrog private repository.
+
+To configure your credentials for Jfrog, go to your Jfrog user profile, and generate an identity token. Then set the following two environment variables:
+```shell
+poetry config http-basic.jfrog-server <username> <password>
+```
+Where `<username>` is your Jfrog username and `<password>` is the identity token you generated.
+
+If you wish to install the dependencies from the public PyPI repository, remove the following source from `pyproject.toml`:
+```toml
+[[tool.poetry.source]]
+name = 'jfrog-server'
+url = 'https://repox.jfrog.io/artifactory/api/pypi/sonarsource-pypi/simple'
+```
+
+## Run the tests only
+
+Run `poetry run pytest test/`
+
+## Run the tests with coverage and results displayed in the terminal
+
+Run `poetry run pytest --cov-report=term-missing --cov-config=pyproject.toml --cov=src --cov-branch tests`
+
+## Run the tests with coverage and store the result in an xml file
+
+Run `poetry run pytest --cov-report=xml:coverage.xml --cov-config=pyproject.toml --cov=src --cov-branch tests`
+
+# Build the package
+
+Run `poetry build` to create the package. 
+The binaries will be located in the `dist` directory at the root level of the project.
+
+# Publish the script
+
+Create a GitHub release.
+
+# Update the package version
+
+To update the version use the Poetry command:
+
+```
+poetry version "X.Y.Z"
+```
+or
+```shell
+poetry version patch
+```
+For more options on the version update see [the Poetry documentation](https://python-poetry.org/docs/cli/#version)
+
+# Tooling 
+## Formatting 
+
+Run `poetry run black src/ tests/ --check` to run the check the formatting on all files.
+To automatically apply formatting, run `poetry run black src/ tests/`.
+
+## Type checking
+
+Run `poetry run mypy src/ tests/ --ignore-missing-imports` to execute the type checking on all files.
+
+## License header
+
+Before pushing, please check if all files have a license header.
+If not all files have a license header please execute: 
+```
+poetry run licenseheaders -t license_header.tmpl -o "SonarSource SA" -y 2011-2024 -n "Sonar Scanner Python" -E .py -d src/
+poetry run licenseheaders -t license_header.tmpl -o "SonarSource SA" -y 2011-2024 -n "Sonar Scanner Python" -E .py -d tests/
+```

README.md

@@ -132,91 +132,6 @@ $ pysonar
 
 See the __SonarScanner__ [documentation](https://docs.sonarsource.com/sonarqube/9.9/analyzing-source-code/scanners/sonarscanner/) for more information.
 
-# For developers
-
-## Prerequisites
-
- - Python 3.12
- - [pipx](https://github.com/pypa/pipx)
-
-## Install poetry
-
-Install poetry with `pipx install poetry`
-
-# Run the main script
-
-Run `python src/pysonar`
-
-# Run the tests
-
-Run `poetry install` to install the dependencies. By default, the dependencies are installed from the Jfrog private repository.
-
-To configure your credentials for Jfrog, go to your Jfrog user profile, and generate an identity token. Then set the following two environment variables:
-```shell
-poetry config http-basic.jfrog-server <username> <password>
-```
-Where `<username>` is your Jfrog username and `<password>` is the identity token you generated.
-
-If you wish to install the dependencies from the public PyPI repository, remove the following source from `pyproject.toml`:
-```toml
-[[tool.poetry.source]]
-name = 'jfrog-server'
-url = 'https://repox.jfrog.io/artifactory/api/pypi/sonarsource-pypi/simple'
-```
-
-## Run the tests only
-
-Run `poetry run pytest test/`
-
-## Run the tests with coverage and results displayed in the terminal
-
-Run `poetry run pytest --cov-report=term-missing --cov-config=pyproject.toml --cov=src --cov-branch tests`
-
-## Run the tests with coverage and store the result in an xml file
-
-Run `poetry run pytest --cov-report=xml:coverage.xml --cov-config=pyproject.toml --cov=src --cov-branch tests`
-
-# Build the package
-
-Run `poetry build` to create the package. 
-The binaries will be located in the `dist` directory at the root level of the project.
-
-# Publish the script
-
-Create a GitHub release.
-
-# Update the package version
-
-To update the version use the Poetry command:
-
-```
-poetry version "X.Y.Z"
-```
-or
-```shell
-poetry version patch
-```
-For more options on the version update see [the Poetry documentation](https://python-poetry.org/docs/cli/#version)
-
-# Tooling 
-## Formatting 
-
-Run `poetry run black src/ tests/ --check` to run the check the formatting on all files.
-To automatically apply formatting, run `poetry run black src/ tests/`.
-
-## Type checking
-
-Run `poetry run mypy src/ tests/ --ignore-missing-imports` to execute the type checking on all files.
-
-## License header
-
-Before pushing, please check if all files have a license header.
-If not all files have a license header please execute: 
-```
-poetry run licenseheaders -t license_header.tmpl -o "SonarSource SA" -y 2011-2024 -n "Sonar Scanner Python" -E .py -d src/
-poetry run licenseheaders -t license_header.tmpl -o "SonarSource SA" -y 2011-2024 -n "Sonar Scanner Python" -E .py -d tests/
-```
-
 # Installation from testPyPI
 
 To install the latest pre-released version of Sonar Scanner Python. Execute the following command: