Skip to content

Conversation

@altaskur
Copy link
Owner

@altaskur altaskur commented Feb 4, 2026

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

  • CONTRIBUTING.md: Added "SonarQube Local Project Setup" section with complete wizard flow:
    • Step 1 of 2: Local project creation (name, key, main branch)
    • Step 2 of 2: "Clean as You Code" configuration (baseline for new code)
    • Analysis method selection (Locally)
    • Project token generation and configuration
    • Added troubleshooting section with common issues
  • CONTRIBUTING.md: Replicated all changes in Spanish version
  • docker-compose.yml: Updated SonarQube image from lts-community to 24.12.0.100206-community (current stable LTA version)

Type of Change

  • 📝 Documentation update
  • 🔧 Build/configuration changes

Impact Assessment

Database Impact

  • No database changes

Backup Impact

  • No impact on backups

Testing

How Has This Been Tested?

  • Manual testing
  • Tested with SonarQube analysis

Test Steps

  1. Start SonarQube with docker-compose up -d
  2. Follow the new step-by-step documentation to create a local project
  3. Generate analysis token according to instructions
  4. Configure .env with the token
  5. Run npm run sonar:check and verify Quality Gate passes

Test Configuration

  • Node version: 20.x
  • npm version: 10.x
  • Platform tested: Windows

UI Changes

N/A - Documentation changes only

Checklist

  • My code follows the project's coding standards
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings or errors
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have run npm run lint and fixed any issues
  • I have run npm test and all tests pass
  • I have run npm run test:electron and all tests pass
  • I have run npm run sonar:check and the analysis passes
  • Any dependent changes have been merged and published

Breaking Changes

  • This PR contains breaking 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 intermediate "Clean as You Code" step that appears after creating the project
  • The analysis method selection screen
  • The integrated token generation flow from the wizard (vs. manually navigating to My Account → Security)

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:

  • Clarity of documented steps in both languages (English and Spanish)
  • Consistency between documentation and actual SonarQube 24.12 process
  • Appropriateness of selected Docker version (24.12.0.100206-community is the current stable LTA)

@altaskur altaskur added the documentation Improvements or additions to documentation label Feb 4, 2026
@altaskur altaskur linked an issue Feb 4, 2026 that may be closed by this pull request
@altaskur altaskur self-assigned this Feb 4, 2026
@altaskur altaskur merged commit 05f5631 into develop Feb 4, 2026
1 check passed
@github-project-automation github-project-automation bot moved this from Backlog to Done in OpenTimeTracker Feb 4, 2026
@altaskur altaskur deleted the docs/clarify-readme-scope branch February 5, 2026 16:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

docs: clarify README scope and fix development instructions

1 participant