Skip to content

Conversation

@R-Gld
Copy link
Owner

@R-Gld R-Gld commented Dec 21, 2025

This pull request updates the project documentation and configuration to improve clarity, accessibility, and internationalization. The main changes include a comprehensive rewrite of the English README.md, the addition of a French version README_FR.md, and a minor update to the Dockerfile to align with the GitHub CI workflow.

Documentation improvements:

  • Major rewrite and expansion of README.md:

    • The documentation is now in English, with clearer structure and expanded sections covering project architecture, module responsibilities, installation, testing, and development methodology. It provides step-by-step instructions for building, running, and testing the project, and details on CI/CD and code quality tools.
    • Terminology and formatting have been standardized, and all team member references now use consistent English phrasing.
  • Addition of README_FR.md:

    • A full French version of the README is now available, mirroring the content and structure of the English documentation. This makes the project more accessible to French-speaking users and contributors.

Configuration update:

  • Rapport/Dockerfile:
    • The base image comment was updated to reference .github/workflows/ci.yml instead of .gitlab-ci.yml, reflecting the migration to GitHub Actions for CI/CD.

Updated the comment in the Dockerfile to reflect the correct base image used in the GitHub Actions CI workflow.
Revised the project description and learning objectives sections for clarity and consistency. Added detailed installation and setup instructions, including prerequisites and step-by-step commands for building and running the application. Introduced a new README_FR.md file for French-speaking users.
@R-Gld R-Gld self-assigned this Dec 21, 2025
@R-Gld R-Gld merged commit 9ad5511 into dev Dec 21, 2025
5 checks passed
@R-Gld R-Gld deleted the update-readme branch December 21, 2025 22:02
@github-actions
Copy link

Qodana for JVM

11 new problems were found

Inspection name Severity Problems
Duplicate branch in alternation 🔶 Warning 3
Busy wait 🔶 Warning 2
Unused assignment 🔶 Warning 1
Non-distinguishable logging calls ◽️ Notice 4
Non-constant string concatenation as argument to logging call ◽️ Notice 1

☁️ View the detailed Qodana report

Contact Qodana team

Contact us at qodana-support@jetbrains.com

@R-Gld R-Gld added the documentation Improvements or additions to documentation label Dec 21, 2025
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

None yet

Development

Successfully merging this pull request may close these issues.

2 participants