Docs/clarify readme scope #34
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR significantly improves the SonarQube configuration documentation in CONTRIBUTING.md by adding a step-by-step guide through the complete local project creation wizard. It also updates the SonarQube Docker image to a stable, current version.
Goal
Make SonarQube initial setup easier for new contributors by eliminating confusion about intermediate wizard steps that were previously undocumented. This reduces onboarding friction and ensures all developers can run code quality analysis without issues.
Key Changes
lts-communityto24.12.0.100206-community(current stable LTA version)Type of Change
Impact Assessment
Database Impact
Backup Impact
Testing
How Has This Been Tested?
Test Steps
docker-compose up -d.envwith the tokennpm run sonar:checkand verify Quality Gate passesTest Configuration
UI Changes
N/A - Documentation changes only
Checklist
npm run lintand fixed any issuesnpm testand all tests passnpm run test:electronand all tests passnpm run sonar:checkand the analysis passesBreaking Changes
Related Issues
N/A - Proactive documentation improvement
Additional Context
This documentation emerged from the actual local SonarQube setup process, where critical wizard steps were identified that weren't previously documented:
The documentation now accurately reflects the process a developer will see when setting up SonarQube for the first time, eliminating ambiguities and reducing common configuration errors.
The SonarQube Docker version update resolves obsolete version warnings and ensures compatibility with the latest analysis features.
Reviewer Notes
Please pay special attention to: