Skip to content

Conversation

@ScarpettaDavide
Copy link
Contributor

This pull request adds a comprehensive guide for setting up and using SonarQube for Python projects to the docs/Tools/Programming/SonarQube.md file. The guide covers installation, configuration, and usage of SonarQube and SonarScanner, along with an overview of quality gates and rules.

Key Additions:

SonarQube Setup:

  • Instructions for running SonarQube locally using Docker or manual installation, including required dependencies (e.g., Java 17) and setup steps.

SonarScanner Configuration:

  • Steps to download, configure, and use the SonarScanner CLI for analyzing Python projects, including setting up the sonar-project.properties file.

Code Analysis Workflow:

  • Detailed instructions on preparing a SonarQube project, running the scanner, and viewing analysis results in the SonarQube UI.

Quality Gates and Rules:

  • Explanation of quality gates, coding rules, and how they determine project readiness, with examples of default conditions like code coverage and duplication thresholds.

Missing

  • Lint using markdownlint

@ScarpettaDavide ScarpettaDavide requested a review from Copilot May 19, 2025 13:13
@ScarpettaDavide ScarpettaDavide self-assigned this May 19, 2025
@ScarpettaDavide ScarpettaDavide linked an issue May 19, 2025 that may be closed by this pull request
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This pull request adds a comprehensive guide for setting up and using SonarQube with Python projects.

  • Introduces local SonarQube setups using both Docker and manual installation
  • Details steps for configuring and running the SonarScanner CLI
  • Provides an overview of quality gates, rules, and references for further guidance

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add SonarQube instructions

2 participants