Adding PT-BR translation and making the proper adjustments #6033
Conversation
WalkthroughThe pull request updates several README files to include Portuguese language options. It adds new links in README.md, README_CN.md, README_ES.md, README_ID.md, README_JP.md, and README_KR.md. Additionally, a new Brazilian Portuguese README (README_PT-BR.md) is introduced with comprehensive documentation details. Changes
Possibly related issues
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (2)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
README_PT-BR.md (3)
9-17: Add descriptive alt text to images.
Several image tags (e.g. at lines 10–17) do not include alt attributes. For better accessibility and markdownlint compliance, please add appropriate alt text (e.g. “Go version badge”, “Nuclei Releases”, etc.).For example, change:
to:
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
10-10: Images should have alternate text (alt text)
null(MD045, no-alt-text)
11-11: Images should have alternate text (alt text)
null(MD045, no-alt-text)
12-12: Images should have alternate text (alt text)
null(MD045, no-alt-text)
13-13: Images should have alternate text (alt text)
null(MD045, no-alt-text)
14-14: Images should have alternate text (alt text)
null(MD045, no-alt-text)
15-15: Images should have alternate text (alt text)
null(MD045, no-alt-text)
16-16: Images should have alternate text (alt text)
null(MD045, no-alt-text)
17-17: Images should have alternate text (alt text)
null(MD045, no-alt-text)
38-40: Simplify phrasing for performance description.
The sentence at line 40 uses “em um grande número de hosts”, which is somewhat wordy. Consider replacing it with “em inúmeros hosts” for brevity and improved style.A suggested diff:
- ... proporcionando uma varredura rápida em um grande número de hosts. + ... proporcionando uma varredura rápida em inúmeros hosts.🧰 Tools
🪛 LanguageTool
[style] ~40-~40: “um grande número de” é uma expressão prolixa. É preferível dizer “inúmeros”, “inúmeras”, “muitos” ou “muitas”.
Context: ... proporcionando uma varredura rápida em um grande número de hosts. O Nuclei oferece suporte a uma v...(PT_WORDINESS_REPLACE_UM_GRANDE_NÚMERO_DE)
340-371: Final sections and markdown lint issues.
A few minor markdown style suggestions:
• Verify that all links (especially those introduced in tables or contributor sections) are properly paired with opening and closing brackets. One static analysis hint flagged an unpaired bracket around line ~362; please double-check the formatting in the credits and resources sections.
• Also, the contributor section punctuation (e.g. isolated “:heart:” symbols) may benefit from minor adjustment for readability.🧰 Tools
🪛 LanguageTool
[uncategorized] ~349-~349: Sinal de pontuação isolado.
Context: ...tors) e mantêm este projeto atualizado. ❤️ Se você tem uma ideia ou algum t...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~351-~351: Esta palavra é hifenizada.
Context: ...eia ou algum tipo de melhoria, sinta-se à vontade para contribuir e participar do projeto...(PT_COMPOUNDS_PRE_REFORM_À_VONTADE)
[typographical] ~362-~362: Símbolo sem par: “]” aparentemente está ausente
Context: ...ps://github.com/jaeles-project/jaeles), [ChopChop](https://github.com/michelin/Ch...(UNPAIRED_BRACKETS)
🪛 markdownlint-cli2 (0.17.2)
343-343: Bare URL used
null(MD034, no-bare-urls)
345-345: Bare URL used
null(MD034, no-bare-urls)
355-355: Images should have alternate text (alt text)
null(MD045, no-alt-text)
README.md (1)
15-24: Navigation and badge section review.
The rest of the header—shields, badges, and social links—looks well integrated. Ensure that all images in this section have appropriate alt text (most already do), and that navigation remains consistent across language-switching links.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
17-17: Images should have alternate text (alt text)
null(MD045, no-alt-text)
19-19: Images should have alternate text (alt text)
null(MD045, no-alt-text)
21-21: Images should have alternate text (alt text)
null(MD045, no-alt-text)
23-23: Images should have alternate text (alt text)
null(MD045, no-alt-text)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (7)
README.md(1 hunks)README_CN.md(1 hunks)README_ES.md(1 hunks)README_ID.md(1 hunks)README_JP.md(1 hunks)README_KR.md(1 hunks)README_PT-BR.md(1 hunks)
✅ Files skipped from review due to trivial changes (4)
- README_ES.md
- README_KR.md
- README_ID.md
- README_CN.md
🧰 Additional context used
🪛 LanguageTool
README_PT-BR.md
[style] ~40-~40: “um grande número de” é uma expressão prolixa. É preferível dizer “inúmeros”, “inúmeras”, “muitos” ou “muitas”.
Context: ... proporcionando uma varredura rápida em um grande número de hosts. O Nuclei oferece suporte a uma v...
(PT_WORDINESS_REPLACE_UM_GRANDE_NÚMERO_DE)
[locale-violation] ~90-~90: “Templates” é um estrangeirismo. É preferível dizer “modelos”.
Context: ...leases/tag/v2.5.2). O projeto [Nuclei-Templates](https://github.com/projectdiscovery/...
(PT_BARBARISMS_REPLACE_TEMPLATES)
[locale-violation] ~92-~92: “templates” é um estrangeirismo. É preferível dizer “modelos”.
Context: ...munidade. Você também pode usar a flag update-templates para atualizar os modelos do Nuclei a ...
(PT_BARBARISMS_REPLACE_TEMPLATES)
[uncategorized] ~349-~349: Sinal de pontuação isolado.
Context: ...tors) e mantêm este projeto atualizado. ❤️ Se você tem uma ideia ou algum t...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~351-~351: Esta palavra é hifenizada.
Context: ...eia ou algum tipo de melhoria, sinta-se à vontade para contribuir e participar do projeto...
(PT_COMPOUNDS_PRE_REFORM_À_VONTADE)
[typographical] ~362-~362: Símbolo sem par: “]” aparentemente está ausente
Context: ...ps://github.com/jaeles-project/jaeles), [ChopChop](https://github.com/michelin/Ch...
(UNPAIRED_BRACKETS)
🪛 markdownlint-cli2 (0.17.2)
README_PT-BR.md
10-10: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
11-11: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
12-12: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
13-13: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
14-14: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
15-15: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
16-16: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
17-17: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
88-88: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
334-334: Bare URL used
null
(MD034, no-bare-urls)
343-343: Bare URL used
null
(MD034, no-bare-urls)
345-345: Bare URL used
null
(MD034, no-bare-urls)
355-355: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
🔇 Additional comments (4)
README_JP.md (1)
32-34:⚠️ Potential issueInconsistent Portuguese link target in Japanese README.
The newly added link at line 34 is labeled “ポルトガル語” (Portuguese) but it points to README_ES.md rather than the Portuguese README (README_PT-BR.md). Please verify if this is intentional or update it to target README_PT-BR.md.README_PT-BR.md (2)
1-8: Overall structure and header are clear.
The header and introductory section for this new Portuguese README are well structured.
88-98: Heading level and terminology consistency.
The section title “### Modelos do Nuclei” is appropriate; however, please review the incremental consistency of heading levels throughout the document. Also, verify that command-line flags (such asupdate-templates) remain in English if that is the intended design, while descriptive text uses Portuguese.🧰 Tools
🪛 LanguageTool
[locale-violation] ~90-~90: “Templates” é um estrangeirismo. É preferível dizer “modelos”.
Context: ...leases/tag/v2.5.2). O projeto [Nuclei-Templates](https://github.com/projectdiscovery/...(PT_BARBARISMS_REPLACE_TEMPLATES)
[locale-violation] ~92-~92: “templates” é um estrangeirismo. É preferível dizer “modelos”.
Context: ...munidade. Você também pode usar a flagupdate-templatespara atualizar os modelos do Nuclei a ...(PT_BARBARISMS_REPLACE_TEMPLATES)
🪛 markdownlint-cli2 (0.17.2)
88-88: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3(MD001, heading-increment)
README.md (1)
5-11: Incorrect Portuguese link target in language options.
In the language navigation block, the newly added “Portuguese” link at line 11 points to README_ES.md. Based on consistency with other language files (e.g. README_CN.md and README_ID.md use README_PT-BR.md for Portuguese), this link should likely target README_PT-BR.md instead.
A suggested change:- <a href="https://github.com/projectdiscovery/nuclei/blob/main/README_ES.md">`Portuguese`</a> + <a href="https://github.com/projectdiscovery/nuclei/blob/main/README_PT-BR.md">`Portuguese`</a>
Proposed changes
This PR adds the Portuguese translation of the README file for Nuclei, addressing the feature request #6032 . The translation aims to enhance the accessibility of Nuclei to Portuguese-speaking users by providing clear and concise instructions in their native language
Checklist
Summary by CodeRabbit