Skip to content

i18n(fr): add contributing pages#38

Merged
dreyfus92 merged 2 commits into
withstudiocms:mainfrom
ArmandPhilippot:i18n/fr-add-contributing
Apr 2, 2025
Merged

i18n(fr): add contributing pages#38
dreyfus92 merged 2 commits into
withstudiocms:mainfrom
ArmandPhilippot:i18n/fr-add-contributing

Conversation

@ArmandPhilippot
Copy link
Copy Markdown
Member

@ArmandPhilippot ArmandPhilippot commented Apr 2, 2025

Description

Creates the French translation of the contributing pages.

Summary by CodeRabbit

  • Documentation
    • Introduced three new guides in French to support contributors.
    • One guide details processes for resolving tickets and submitting pull requests.
    • Another serves as an introductory guide for getting started with contributions, including community guidelines.
    • A third outlines how to assist with translations and manage multilingual contributions.

@ArmandPhilippot ArmandPhilippot requested a review from a team as a code owner April 2, 2025 11:54
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 2, 2025

Walkthrough

This pull request introduces three new Markdown documentation files under the French contributions directory. The files provide guidelines for different aspects of contributing to the StudioCMS project, including code contributions, getting started instructions, and translation processes. Each document is enriched with metadata and detailed steps covering ticket resolution, repository setup, testing, and pull request submission, along with links to community resources and translation management information.

Changes

Files Change Summary
src/content/docs/fr/contributing/code-contributions.mdx, src/content/docs/fr/contributing/getting-started.mdx, src/content/docs/fr/contributing/translations.mdx Added new Markdown guides in French covering code contributions, getting started instructions, and translation contributions for the StudioCMS project, including detailed steps, metadata, and resource links for contributors.

Possibly related PRs

  • i18n(es): more updates #29: Updates the Spanish documentation for contributions, which is related at code-level as both PRs enhance contributor guidelines and similar documentation structures.

Suggested labels

i18n

Suggested reviewers

  • dreyfus92

Poem

I’m a rabbit with a hop so bright,
Celebrating docs that guide the night.
Contributions bloom like spring anew,
With guides for code and languages too.
In StudioCMS, our paths align,
Follow the lines—let creations shine!
🐇✨


🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@studiocms-no-reply
Copy link
Copy Markdown
Member

studiocms-no-reply commented Apr 2, 2025

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

File Note
fr/contributing/code-contributions.mdx Localization added, will be marked as complete.
fr/contributing/getting-started.mdx Localization added, will be marked as complete.
fr/contributing/translations.mdx Localization added, will be marked as complete.
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (10)
src/content/docs/fr/contributing/getting-started.mdx (3)

8-8: Import Statement Formatting
The import of the ContributorList component is correctly implemented. Please ensure that the spacing before the semicolon aligns with your team’s style guidelines (e.g. using a narrow no‑break space if required).

🧰 Tools
🪛 LanguageTool

[uncategorized] ~8-8: Le point-virgule est précédé d’une espace fine insécable.
Context: ...from '
/components/ContributorList.astro'; Merci d’investir votre temps pour cont...

(FRENCH_WHITESPACE)


10-14: Content Clarity & Link Usage
The introductory paragraph is friendly and informative. For the hyperlink labeled “[Comment cela fonctionne][how-it-works]”, double‑check that its phrasing and any punctuation (such as the absence of unnecessary hyphens) adheres to French typographical standards.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~14-~14: Le trait d’union doit être supprimé.
Context: ...ez la section [Comment cela fonctionne][how-it-works]. ## Nos contributeurs Notre pr...

(MOT_TRAIT_MOT)


22-27: Guidance for Bug Reporting & Link Reference
The instructions for reporting bugs and requesting features are clear. To enhance consistency with French terminology, consider replacing the inline comment “{/* Links /}” with “{/ Liens */}”. Also, review the reference link on line 27 for proper spacing around the colon and confirm that any hyphen usage in the identifier aligns with your style guide.

🧰 Tools
🪛 LanguageTool

[style] ~26-~26: Alternatives possibles pour cet anglicisme :
Context: ...ire de la fonctionnalité proposée. {/* Links */} [how-it-works]: /fr/how-it-works/

(FR_SIMPLE_REPLACE_ANGLICISM_PREMIUM_LINKS)


[uncategorized] ~27-~27: Le trait d’union doit être supprimé.
Context: ...onctionnalité proposée. {/* Links */} [how-it-works]: /fr/how-it-works/

(MOT_TRAIT_MOT)


[uncategorized] ~27-~27: Les deux-points sont précédés d’une espace insécable.
Context: ...é proposée. {/* Links */} [how-it-works]: /fr/how-it-works/

(FRENCH_WHITESPACE)


[uncategorized] ~27-~27: Le trait d’union doit être supprimé.
Context: ...sée. {/* Links */} [how-it-works]: /fr/how-it-works/

(MOT_TRAIT_MOT)

src/content/docs/fr/contributing/translations.mdx (2)

12-12: Component Import Consistency
The import of the ReadMore component is properly formatted. As with similar statements in other files, please verify that any spacing (especially before the semicolon) matches your team’s conventions.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~12-12: Le point-virgule est précédé d’une espace fine insécable.
Context: ...adMore from '
/components/ReadMore.astro'; StudioCMS est un projet mondial et nou...

(FRENCH_WHITESPACE)


22-24: Dashboard & Repository Contribution Instructions
The directions for both using the i18n dashboard and contributing directly through the repository are clear. Consider reordering the adverb placement—e.g. “vous pouvez directement l’ajouter dans le tableau de bord”—to enhance clarity and conform to French syntax standards.

🧰 Tools
🪛 LanguageTool

[style] ~22-~22: L’adverbe précède le verbe à l’infinitif.
Context: ...ngue n’est pas répertoriée, vous pouvez l’ajouter directement dans le tableau de bord. Si vous préfé...

(PLACE_DE_L_ADVERBE)


[style] ~24-~24: L’adverbe précède le verbe à l’infinitif.
Context: ...s le tableau de bord. Si vous préférez contribuer directement aux traductions dans le dépôt, les trad...

(PLACE_DE_L_ADVERBE)


[typographical] ~24-~24: Caractère d’apostrophe incorrect.
Context: ...aductions sont stockées dans le dossier [`packages/studiocms/src/lib/i18n/translat...

(APOS_INCORRECT)


[typographical] ~24-~24: Caractère d’apostrophe incorrect.
Context: ... traductions en anglais dans le fichier [en-us.json](https://github.com/withstud...

(APOS_INCORRECT)

src/content/docs/fr/contributing/code-contributions.mdx (5)

9-9: Import Statement Consistency
The import of the Steps component from '@astrojs/starlight/components' is correctly implemented. Please ensure that the semicolon spacing follows your project’s style guidelines.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~9-~9: Le point-virgule est précédé d’une espace fine insécable.
Context: ...ps } from '@astrojs/starlight/components'; Dans ce guide, vous obtiendrez un aper...

(FRENCH_WHITESPACE)


15-17: Ticket Resolution Section
The “Résoudre un ticket” segment is clear and useful with its GitHub link. You might streamline the sentence structure for greater readability, for example by using a more direct phrase instead of a long relative clause.

🧰 Tools
🪛 LanguageTool

[style] ~17-~17: Une autre structure plus directe dynamisera votre phrase.
Context: ...se. Vous pouvez affiner votre recherche en utilisant les labels comme filtres. Si vous tro...

(EN_UTILISANT)


21-37: Step-by-Step Contribution Process
The steps within the component comprehensively guide the contributor through forking the repository, setting up the environment, and beginning modifications. Consider rewording phrases like “En utilisant la ligne de commande” to “Via la ligne de commande” for a more direct tone. Also, verify that bullet items maintain consistent capitalization and style (for instance, whether list items should start with a lowercase letter).

🧰 Tools
🪛 LanguageTool

[style] ~27-~27: Une autre structure plus directe dynamisera votre phrase.
Context: ...positories-from-github-desktop) ! - En utilisant la ligne de commande : - [Dupliqu...

(EN_UTILISANT)


[uncategorized] ~28-~28: Ce mot doit commencer par une minuscule.
Context: ...ilisant la ligne de commande : - [Dupliquez le dépôt](https://docs.github.com/fr/pu...

(DEUX_POINTS_MAJ)


[typographical] ~28-~28: Pas de correspondance fermante ou ouvrante pour le caractère « [ »
Context: ...e commande : - [Dupliquez le dépôt](https://docs.github.com/fr/pull-request...

(UNPAIRED_BRACKETS)


[style] ~30-~30: Un autre mot peut sembler plus précis et percutant.
Context: ... prêt à les fusionner. 2. Installez ou mettez à jour Node.js et pnpm vers les versio...

(METTRE_A_JOUR)


[typographical] ~30-~30: Caractère d’apostrophe incorrect.
Context: ...npm** vers les versions spécifiées dans [.prototools](https://github.com/withstu...

(APOS_INCORRECT)


[style] ~36-~36: Un autre mot peut sembler plus précis et percutant.
Context: ... vos modifications, le cas échéant. 5. Mettez à jour la documentation, si nécessaire. </Step...

(METTRE_A_JOUR)


43-52: Pull Request Submission Guidelines
The guidelines for creating a pull request are detailed and helpful. A minor stylistic suggestion: rephrase “N’oubliez pas de [lier la PR au ticket]…” to a more direct instruction (e.g. “Veillez à lier la PR au ticket”) to improve clarity.

🧰 Tools
🪛 LanguageTool

[style] ~47-~47: Cette structure peut être améliorée afin de devenir plus percutante.
Context: ...’objectif de votre demande de fusion. - N’oubliez pas de [lier la PR au ticket](https://docs.git...

(N_OUBLIE_PAS)


[style] ~50-~50: Une autre structure plus directe dynamisera votre phrase.
Context: ...t qu’une PR puisse être fusionnée, soit en utilisant des [suggestions de modifications](http...

(EN_UTILISANT)


[style] ~51-~51: Un autre mot peut sembler plus précis et percutant.
Context: ... branche. - Au fur et à mesure que vous mettez à jour votre PR et appliquez les modifications...

(METTRE_A_JOUR)


62-63: Link Reference Formatting
At the document’s end, the inline comment “{/* Links /}” is used to demarcate link references. For consistency with the French language used throughout, consider changing this to “{/ Liens */}”. Also, verify that the link reference for “[contributors]” on line 63 uses proper typographical spacing (e.g. around colons and hyphens) per the French style guidelines.

🧰 Tools
🪛 LanguageTool

[style] ~62-~62: Alternatives possibles pour cet anglicisme :
Context: ... contributeurs][contributors] ! 🎉 {/* Links */} [contributors]: /fr/contributing/ge...

(FR_SIMPLE_REPLACE_ANGLICISM_PREMIUM_LINKS)


[uncategorized] ~63-~63: Les deux-points sont précédés d’une espace insécable.
Context: ...utors] ! 🎉 {/* Links */} [contributors]: /fr/contributing/getting-started/#nos-c...

(FRENCH_WHITESPACE)


[uncategorized] ~63-~63: Le trait d’union doit être supprimé.
Context: ...ks */} [contributors]: /fr/contributing/getting-started/#nos-contributeurs

(MOT_TRAIT_MOT)


[typographical] ~63-~63: Vérifiez l’absence de trait d’union et l’accord entre ces mots.
Context: ...ors]: /fr/contributing/getting-started/#nos-contributeurs

(TIRET)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 38029e4 and ad66741.

📒 Files selected for processing (3)
  • src/content/docs/fr/contributing/code-contributions.mdx (1 hunks)
  • src/content/docs/fr/contributing/getting-started.mdx (1 hunks)
  • src/content/docs/fr/contributing/translations.mdx (1 hunks)
🧰 Additional context used
🪛 LanguageTool
src/content/docs/fr/contributing/translations.mdx

[uncategorized] ~12-12: Le point-virgule est précédé d’une espace fine insécable.
Context: ...adMore from '
/components/ReadMore.astro'; StudioCMS est un projet mondial et nou...

(FRENCH_WHITESPACE)


[style] ~22-~22: L’adverbe précède le verbe à l’infinitif.
Context: ...ngue n’est pas répertoriée, vous pouvez l’ajouter directement dans le tableau de bord. Si vous préfé...

(PLACE_DE_L_ADVERBE)


[style] ~24-~24: L’adverbe précède le verbe à l’infinitif.
Context: ...s le tableau de bord. Si vous préférez contribuer directement aux traductions dans le dépôt, les trad...

(PLACE_DE_L_ADVERBE)


[typographical] ~24-~24: Caractère d’apostrophe incorrect.
Context: ...aductions sont stockées dans le dossier [`packages/studiocms/src/lib/i18n/translat...

(APOS_INCORRECT)


[typographical] ~24-~24: Caractère d’apostrophe incorrect.
Context: ... traductions en anglais dans le fichier [en-us.json](https://github.com/withstud...

(APOS_INCORRECT)

src/content/docs/fr/contributing/getting-started.mdx

[uncategorized] ~8-8: Le point-virgule est précédé d’une espace fine insécable.
Context: ...from '
/components/ContributorList.astro'; Merci d’investir votre temps pour cont...

(FRENCH_WHITESPACE)


[uncategorized] ~14-~14: Le trait d’union doit être supprimé.
Context: ...ez la section [Comment cela fonctionne][how-it-works]. ## Nos contributeurs Notre pr...

(MOT_TRAIT_MOT)


[style] ~18-~18: Utiliser beaucoup de points d’exclamation peut sembler excessif (en l’occurrence : 3 points d’exclamation dans un texte de 1332 caractères de long).
Context: ...diocms) et ajoutez votre nom à la liste ! ## Rapports de bu...

(FR_EXCESSIVE_EXCLAMATION)


[style] ~26-~26: Alternatives possibles pour cet anglicisme :
Context: ...ire de la fonctionnalité proposée. {/* Links */} [how-it-works]: /fr/how-it-works/

(FR_SIMPLE_REPLACE_ANGLICISM_PREMIUM_LINKS)


[uncategorized] ~27-~27: Le trait d’union doit être supprimé.
Context: ...onctionnalité proposée. {/* Links */} [how-it-works]: /fr/how-it-works/

(MOT_TRAIT_MOT)


[uncategorized] ~27-~27: Les deux-points sont précédés d’une espace insécable.
Context: ...é proposée. {/* Links */} [how-it-works]: /fr/how-it-works/

(FRENCH_WHITESPACE)


[uncategorized] ~27-~27: Le trait d’union doit être supprimé.
Context: ...sée. {/* Links */} [how-it-works]: /fr/how-it-works/

(MOT_TRAIT_MOT)

src/content/docs/fr/contributing/code-contributions.mdx

[uncategorized] ~9-~9: Le point-virgule est précédé d’une espace fine insécable.
Context: ...ps } from '@astrojs/starlight/components'; Dans ce guide, vous obtiendrez un aper...

(FRENCH_WHITESPACE)


[style] ~17-~17: Une autre structure plus directe dynamisera votre phrase.
Context: ...se. Vous pouvez affiner votre recherche en utilisant les labels comme filtres. Si vous tro...

(EN_UTILISANT)


[style] ~27-~27: Une autre structure plus directe dynamisera votre phrase.
Context: ...positories-from-github-desktop) ! - En utilisant la ligne de commande : - [Dupliqu...

(EN_UTILISANT)


[uncategorized] ~28-~28: Ce mot doit commencer par une minuscule.
Context: ...ilisant la ligne de commande : - [Dupliquez le dépôt](https://docs.github.com/fr/pu...

(DEUX_POINTS_MAJ)


[typographical] ~28-~28: Pas de correspondance fermante ou ouvrante pour le caractère « [ »
Context: ...e commande : - [Dupliquez le dépôt](https://docs.github.com/fr/pull-request...

(UNPAIRED_BRACKETS)


[style] ~30-~30: Un autre mot peut sembler plus précis et percutant.
Context: ... prêt à les fusionner. 2. Installez ou mettez à jour Node.js et pnpm vers les versio...

(METTRE_A_JOUR)


[typographical] ~30-~30: Caractère d’apostrophe incorrect.
Context: ...npm** vers les versions spécifiées dans [.prototools](https://github.com/withstu...

(APOS_INCORRECT)


[style] ~36-~36: Un autre mot peut sembler plus précis et percutant.
Context: ... vos modifications, le cas échéant. 5. Mettez à jour la documentation, si nécessaire. </Step...

(METTRE_A_JOUR)


[style] ~47-~47: Cette structure peut être améliorée afin de devenir plus percutante.
Context: ...’objectif de votre demande de fusion. - N’oubliez pas de [lier la PR au ticket](https://docs.git...

(N_OUBLIE_PAS)


[style] ~50-~50: Une autre structure plus directe dynamisera votre phrase.
Context: ...t qu’une PR puisse être fusionnée, soit en utilisant des [suggestions de modifications](http...

(EN_UTILISANT)


[style] ~51-~51: Un autre mot peut sembler plus précis et percutant.
Context: ... branche. - Au fur et à mesure que vous mettez à jour votre PR et appliquez les modifications...

(METTRE_A_JOUR)


[style] ~62-~62: Alternatives possibles pour cet anglicisme :
Context: ... contributeurs][contributors] ! 🎉 {/* Links */} [contributors]: /fr/contributing/ge...

(FR_SIMPLE_REPLACE_ANGLICISM_PREMIUM_LINKS)


[uncategorized] ~63-~63: Les deux-points sont précédés d’une espace insécable.
Context: ...utors] ! 🎉 {/* Links */} [contributors]: /fr/contributing/getting-started/#nos-c...

(FRENCH_WHITESPACE)


[uncategorized] ~63-~63: Le trait d’union doit être supprimé.
Context: ...ks */} [contributors]: /fr/contributing/getting-started/#nos-contributeurs

(MOT_TRAIT_MOT)


[typographical] ~63-~63: Vérifiez l’absence de trait d’union et l’accord entre ces mots.
Context: ...ors]: /fr/contributing/getting-started/#nos-contributeurs

(TIRET)

🔇 Additional comments (11)
src/content/docs/fr/contributing/getting-started.mdx (2)

1-7: Front Matter is Well-Structured
The metadata (i18nReady, title, description, sidebar order) is clear and conforms to expected conventions.


16-20: Contributors Section Tone
The “Nos contributeurs” section is inviting and clearly communicates appreciation for community input. Note that the enthusiastic exclamation mark reinforces a positive tone; just ensure this style is consistent with the rest of your documentation.

🧰 Tools
🪛 LanguageTool

[style] ~18-~18: Utiliser beaucoup de points d’exclamation peut sembler excessif (en l’occurrence : 3 points d’exclamation dans un texte de 1332 caractères de long).
Context: ...diocms) et ajoutez votre nom à la liste ! ## Rapports de bu...

(FR_EXCESSIVE_EXCLAMATION)

src/content/docs/fr/contributing/translations.mdx (5)

1-10: Front Matter Validation
The front matter correctly lists properties such as i18nReady, title, description, sidebar order, and even includes a badge. Everything is clear and complete.


14-15: Introduction to Translation Contributions
The introductory text explaining the global nature of StudioCMS and inviting contributions is clear and well‑phrased.


16-20: i18n Dashboard Section
The “Tableau de bord i18n” section provides a concise status overview with an appropriate image. The alt text for the image is descriptive, ensuring accessibility.


26-28: Explanation of Crowdin Integration
The use of the ReadMore component to elaborate on Crowdin and provide helpful links works well. The content is concise and informative.


30-35: Documentation Translation Teaser
The final section regarding forthcoming documentation translations is clear and encourages users to engage further (e.g. via Discord). The call to action is effective.

src/content/docs/fr/contributing/code-contributions.mdx (4)

1-7: Front Matter Clarity
The metadata in this file is clearly defined and communicates the document’s purpose regarding code contributions effectively.


11-13: Introduction to the Contribution Process
The opening lines introduce the guide well, providing an overview of what the contributor can expect. The text is clear; consider a slightly more direct phrasing if you’d like to make the call to action even stronger.


39-42: Validation Process Overview
The brief instructions on validating one’s updates by committing changes are clear and to the point.


54-60: Final PR Confirmation & Community Engagement
The congratulatory message and invitation to further engage with the community strike a warm and positive tone. The inclusion of an emoji enhances friendliness; just ensure that this style is consistent with project standards.

Copy link
Copy Markdown
Member

@dreyfus92 dreyfus92 left a comment

Choose a reason for hiding this comment

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

LGTM ✅

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants