Skip to content

docs: add Turkish README & enhance CONTRIBUTING.md#6740

Merged
dwisiswant0 merged 1 commit intoprojectdiscovery:devfrom
bahattinyunus:feature/tr-docs-and-contributing
Jan 5, 2026
Merged

docs: add Turkish README & enhance CONTRIBUTING.md#6740
dwisiswant0 merged 1 commit intoprojectdiscovery:devfrom
bahattinyunus:feature/tr-docs-and-contributing

Conversation

@bahattinyunus
Copy link
Contributor

@bahattinyunus bahattinyunus commented Dec 28, 2025

Description

This PR aims to improve the global accessibility of Nuclei and enhance the developer onboarding experience.

Changes

  1. Added Turkish Documentation (README_TR.md):

    • Created a full translation of the main README.md into Turkish (Türkçe) to support the growing Turkish security community.
    • Updated the main README.md header to include a link to the Turkish translation.
  2. Enhanced CONTRIBUTING.md:

    • Added a new Development section.
    • Documented standard Make commands (make test, make vet, make build) to help new contributors run checks locally before submitting PRs.

Type of Change

  • Documentation update

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have added tests that prove my fix is effective or that my feature works (N/A for docs)
  • New and existing unit tests pass locally with my changes

Summary by CodeRabbit

  • Documentation
    • Added Turkish (Türkçe) language support with fully localized project documentation.
    • Enhanced contributor guidelines with pre-submit validation steps including testing, linting, and build procedures.

✏️ Tip: You can customize this high-level summary in your review settings.

@auto-assign auto-assign bot requested a review from dogancanbakir December 28, 2025 12:48
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 28, 2025

Walkthrough

This PR extends Turkish language support by introducing a Turkish-localized README file (README_TR.md) with a complete translation of project documentation, adds a Turkish language link to the main README, and documents pre-submit development validation steps in CONTRIBUTING.md.

Changes

Cohort / File(s) Summary
Documentation & Localization
README.md, README_TR.md
Adds Turkish translation of the complete README with localized content, badges, navigation, and sections. Updates main README to include Turkish language link.
Development Guidelines
CONTRIBUTING.md
Adds "Development" subsection under Code Style documenting pre-submit validation commands (make test, make vet, make build).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 A document in Turkish now hops forth with glee,
The README translated for all folk to see,
With guidelines for builders and locales so wide,
This project now welcomes with multilingual pride!

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check ✅ Passed The title 'docs: add Turkish README & enhance CONTRIBUTING.md' accurately summarizes the main changes: adding Turkish documentation and improving contribution guidelines.
✨ Finishing touches
  • 📝 Generate docstrings

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

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

Copy link
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: 3

📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 78e90e3 and 26a2e5d.

📒 Files selected for processing (3)
  • CONTRIBUTING.md
  • README.md
  • README_TR.md
🧰 Additional context used
🪛 LanguageTool
README_TR.md

[style] ~94-~94: The word “ya” is non-standard. Did you mean “you”, “your” or “yes”?
Context: ...nuz ve karmaşık gereksinimleriniz varsa [Pro'ya kaydolun](https://projectdiscovery.i...

(YA)


[grammar] ~231-~231: Ensure spelling is correct
Context: ...sında geniş çapta tanınmaktadır. Nuclei şablonları, dünya çapında binlerce güvenlik araştı...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🪛 markdownlint-cli2 (0.18.1)
README_TR.md

18-18: Images should have alternate text (alt text)

(MD045, no-alt-text)


20-20: Images should have alternate text (alt text)

(MD045, no-alt-text)


22-22: Images should have alternate text (alt text)

(MD045, no-alt-text)


57-57: Link fragments should be valid

(MD051, link-fragments)


58-58: Link fragments should be valid

(MD051, link-fragments)


75-75: Tables should be surrounded by blank lines

(MD058, blanks-around-tables)


105-105: Images should have alternate text (alt text)

(MD045, no-alt-text)


105-105: Images should have alternate text (alt text)

(MD045, no-alt-text)


238-238: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4

(MD001, heading-increment)

🔇 Additional comments (5)
CONTRIBUTING.md (1)

25-42: ✓ Clean addition of contributor pre-submit guidance.

The new Development section clearly documents standard validation steps before PR submission. Formatting is consistent with existing documentation style, and the commands are presented in accessible code blocks. This should improve contributor experience by reducing feedback cycles.

README.md (1)

11-12: ✓ Language link added consistently.

Turkish translation link follows the established pattern for other language versions. Formatting and URL structure are correct.

README_TR.md (3)

75-75: The proper blank line spacing already exists around the table. A blank line precedes the blockquote at line 73, and a blank line follows it at line 78. No action is needed.

Likely an incorrect or invalid review comment.


94-94: > Likely an incorrect or invalid review comment.


57-58: Unable to verify anchor consistency — file not accessible.

README_TR.md could not be accessed through the repository clone or public search. The file may exist in a specific branch or PR context. Manual verification of the Table of Contents anchor references (lines 57-58) against actual Turkish heading IDs throughout the document is required to ensure internal links are correct.

@dwisiswant0 dwisiswant0 changed the title Add Turkish Documentation & Enhance Contribution Guidelines docs: add Turkish doc & enhance contribution guidelines Jan 5, 2026
Copy link
Member

@dwisiswant0 dwisiswant0 left a comment

Choose a reason for hiding this comment

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

Thank you for your contributions, it LGTM!

@dwisiswant0 dwisiswant0 changed the title docs: add Turkish doc & enhance contribution guidelines docs: add Turkish README & enhance CONTRIBUTING.md Jan 5, 2026
@dwisiswant0 dwisiswant0 merged commit 826f04e into projectdiscovery:dev Jan 5, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants