docs: Add comprehensive translation guide and reference in CONTRIBUTING

Addresses #6596 by providing detailed documentation for contributors
on how to submit translations via Crowdin, including best practices,
guidelines, and workflow information.
This commit is contained in:
Itszeeshanrajput 2026-02-25 20:32:19 +05:00
parent 2f72ae5bf6
commit 0cb6c2e12c
2 changed files with 168 additions and 1 deletions

View file

@ -85,7 +85,9 @@ If you encounter a bug while using ReVanced Patches, open an issue using the
## 🌐 Submitting translations
You can contribute translations at [translate.revanced.app](https://translate.revanced.app).
You can contribute translations at [translate.revanced.app](https://translate.revanced.app).
For detailed translation guidelines and best practices, see our [Translation Guide](docs/TRANSLATIONS.md).
## 🧑‍⚖️ Guidelines for requesting or contributing patches

165
docs/TRANSLATIONS.md Normal file
View file

@ -0,0 +1,165 @@
# 🌐 Translation Guide for ReVanced Patches
This guide explains how to contribute translations to ReVanced Patches.
## Overview
ReVanced Patches supports multiple languages through Crowdin, a collaborative translation platform. Translations help make ReVanced accessible to users worldwide.
## How to Contribute Translations
### 1. Access Crowdin
Visit the ReVanced translation platform:
- **URL:** https://translate.revanced.app
### 2. Create an Account
If you don't have a Crowdin account:
1. Click "Sign Up" on the Crowdin page
2. Complete the registration process
3. Verify your email address
### 3. Select Your Language
1. Browse the list of available languages
2. Click on your preferred language
3. If your language isn't listed, request it by opening an issue
### 4. Start Translating
1. Select a file or string to translate
2. Read the source text (usually in English)
3. Provide an accurate translation in your language
4. Submit your translation for review
## Translation Guidelines
### Best Practices
- **Accuracy:** Ensure translations convey the original meaning
- **Consistency:** Use consistent terminology throughout
- **Context:** Consider the context where the text appears
- **Natural Language:** Write naturally in your target language
- **Technical Terms:** Keep technical terms in English when appropriate
### What to Translate
- User interface strings
- Settings descriptions
- Error messages
- Feature descriptions
- Help text
### What NOT to Translate
- Code snippets
- Package names
- API endpoints
- Version numbers
- URLs (unless localized versions exist)
## Translation Workflow
1. **Submit Translation** - Provide your translation on Crowdin
2. **Community Review** - Other translators may review your work
3. **Approval** - Maintainers approve quality translations
4. **Integration** - Approved translations are merged into ReVanced Patches
5. **Release** - Translations appear in the next release
## Quality Standards
### Required
- ✅ Grammatically correct
- ✅ Contextually appropriate
- ✅ Consistent with existing translations
- ✅ Free of spelling errors
### Recommended
- 💡 Natural and idiomatic
- 💡 Culturally appropriate
- 💡 Concise when possible
- 💡 Follows language-specific conventions
## Common Translation Scenarios
### Settings Strings
**Example:**
- **English:** "Enable dark theme"
- **Translation:** Should convey enabling a dark color scheme
### Error Messages
**Example:**
- **English:** "Failed to apply patch"
- **Translation:** Should clearly indicate a patch application failure
### Feature Descriptions
**Example:**
- **English:** "Removes advertisements from the video player"
- **Translation:** Should explain the ad removal functionality
## Reporting Translation Issues
If you find incorrect or missing translations:
1. Open an issue on GitHub: https://github.com/ReVanced/revanced-patches/issues
2. Use the title format: `bug: Translation issue in [Language] - [Description]`
3. Provide:
- The incorrect translation
- The correct translation
- Context where it appears
## Language Coverage
ReVanced Patches aims to support:
- Major world languages (English, Spanish, French, German, etc.)
- Regional variants (Brazilian Portuguese, Simplified Chinese, etc.)
- Right-to-left languages (Arabic, Hebrew, etc.)
## Getting Help
- **Crowdin Support:** Use Crowdin's built-in help system
- **Community:** Join the ReVanced Discord for translation discussions
- **Documentation:** Refer to Crowdin's official documentation
## Recognition
All translators are credited in:
- Crowdin project page
- ReVanced community acknowledgments
- Release notes (for significant contributions)
## Frequently Asked Questions
### How long does it take for translations to appear?
Translations are typically included in the next release after approval, usually within 1-2 weeks.
### Can I translate multiple languages?
Yes! You can contribute translations for any language you're proficient in.
### What if I make a mistake?
You can edit your translations on Crowdin before they're approved. After approval, open an issue to request corrections.
### Are machine translations acceptable?
No. Only human translations are accepted to ensure quality and accuracy.
## Thank You!
Your translation contributions help millions of users worldwide access ReVanced in their native language. Thank you for making ReVanced more accessible! 🌍
---
For more information, visit:
- **Crowdin Platform:** https://translate.revanced.app
- **ReVanced Documentation:** https://github.com/ReVanced/revanced-documentation
- **Contributing Guidelines:** https://github.com/ReVanced/revanced-patches/blob/main/CONTRIBUTING.md