Fix/update docs

[Karamouche]

What does this PR do?

Updates readme and pull request template for more calrity

Type of change

• New language (languages/{lang}/)
• New step (steps/text/ or steps/word/)
• New preset version (presets/)
• Bug fix
• Refactor / internal cleanup
• Docs / CI

Summary by CodeRabbit

• Documentation

  • Updated supported languages table in README with expanded language support: German (de), Italian (it), and Spanish (es) now included. Improved table formatting and column header clarity for better readability.

• Chores

  • Enhanced pull request template with improved submission instructions, refined checklists for language and step changes, and clearer contributor guidance for various modification types.

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request updates two documentation files: refining the GitHub pull request template with clearer guidance and more detailed checkpoints for different contribution types, and expanding the README's supported languages table with new language entries.

Changes

Cohort / File(s)	Summary
PR Template Update .github/pull_request_template.md	Refined placeholder instructions to specify "one sentence: what changed and why," reorganized "Type of change" checklist with broader categories, restructured guidance sections for new languages (targeting normalization/languages/{lang}/ with LanguageConfig requirements), editing existing languages/steps, new steps (emphasizing unique YAML-keyed names and config reading), and preset changes (adding pipeline.validate() requirement), and replaced "Tests" section with explicit uv run pytest tests/ command.
Supported Languages Update README.md	Updated "Supported languages" table by changing "French (alpha)" to "French" and adding three new language codes: de (German), it (Italian), and es (Spanish).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 Our template now guides with clarity bright,
New languages sprouting—German, Italian in sight!
Documentation dancing in neat little rows,
Spanish and French where the good guidance flows,
A well-organized warren, from checklist to test!

🚥 Pre-merge checks | ✅ 1 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The PR description is incomplete: it lacks the required 'What does this PR do?' section details and omits the 'Tests' section entirely from the template.	Add a detailed one-sentence summary in 'What does this PR do?' section and include the 'Tests' section describing what was tested and how.
Title check	❓ Inconclusive	The title 'Fix/update docs' is vague and generic, using a placeholder term that lacks specificity about what documentation was changed.	Replace with a more specific title describing the main documentation changes, such as 'Update README with new language support and improve PR template clarity'.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch fix/update-docs

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In @.github/pull_request_template.md:
- Around line 74-76: Add a fence language to the Markdown code block containing
"uv run pytest tests/" by changing the opening triple backticks to include a
language identifier (e.g., bash) so the fenced block becomes "```bash" to
satisfy markdownlint MD040 and improve readability; update the fenced block near
the existing "uv run pytest tests/" snippet accordingly.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: a0a4d805-523b-4d31-9861-307f9f146536

📥 Commits

Reviewing files that changed from the base of the PR and between 667595f and bf38462.

📒 Files selected for processing (2)

• .github/pull_request_template.md
• README.md

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

Add a language to the fenced code block (markdownlint MD040).

Line 74 should specify a fence language to satisfy lint and improve readability.

Proposed fix

-```
+```bash
 uv run pytest tests/

</details>

<details>
<summary>🧰 Tools</summary>

<details>
<summary>🪛 markdownlint-cli2 (0.22.0)</summary>

[warning] 74-74: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

</details>

</details>

<details>
<summary>🤖 Prompt for AI Agents</summary>

Verify each finding against the current code and only fix it if needed.

In @.github/pull_request_template.md around lines 74 - 76, Add a fence language
to the Markdown code block containing "uv run pytest tests/" by changing the
opening triple backticks to include a language identifier (e.g., bash) so the
fenced block becomes "```bash" to satisfy markdownlint MD040 and improve
readability; update the fenced block near the existing "uv run pytest tests/"
snippet accordingly.

</details>

<!-- fingerprinting:phantom:triton:hawk:15d7adc9-b32d-459a-82ca-f41ecc83c053 -->

<!-- This is an auto-generated comment by CodeRabbit -->