diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 775284c6..f3e8ce7f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -79,9 +79,17 @@ runnable directly as `pnpm fetch-favicons`). Only if auto-fetch can't find a usa PNG do you hand-source one (on macOS, `sips` handles ICO→PNG). Remember to commit the PNGs with your change — CI stays offline and only checks they exist. -**Translations** — improvements to the existing `en` / `zh` / `fr` / `ru` packs are -welcome. Adding a whole new locale is heavier than it looks (every future copy change -must land in it too), so please open an issue to discuss before starting one. +**README translations** — beyond the four READMEs we maintain (`en` / `zh` / `fr` / +`ru`), community-maintained translations in any language are welcome. Create +`README_.md` from the English [README.md](README.md) (the canonical source), +open it with a one-line "community-maintained translation — English is canonical" +note in your language, and add your language to the switcher row near the top of the +existing READMEs. Keep code blocks, URLs, and badges unchanged. Check open issues +for requested languages before starting. + +**UI translations** — improvements to the existing `en` / `zh` / `fr` / `ru` packs are +welcome. Adding a whole new UI locale is heavier than it looks (every future copy +change must land in it too), so please open an issue to discuss before starting one. ## Bugs & feature requests diff --git a/README.md b/README.md index d4786513..331f3624 100644 --- a/README.md +++ b/README.md @@ -99,6 +99,13 @@ Full guides live in the MyIP Docs Center: **[docs.ipcheck.ing](https://docs.ipch * [Developer Guide](https://docs.ipcheck.ing/developer) — deployment, configuration, architecture, and contributing * [Knowledge Base](https://docs.ipcheck.ing/knowledge-base) — how to use every tool, step-by-step network diagnosis, and networking concepts +## 🤝 Contributing + +Contributions are welcome! We keep a curated set of beginner-friendly tasks — each with exact file paths, acceptance criteria, and tests that guide you to a green build: + +* 🏷️ [Good first issues](https://github.com/jason5ng32/MyIP/labels/good%20first%20issue) — add a DNS resolver from your country, add curated site lists, translate the README into your language, polish translations, and more +* 📄 [CONTRIBUTING.md](CONTRIBUTING.md) — setup, conventions, and how PRs flow (target the `dev` branch) + ## ⚙️ Configuration Two settings matter before anything else: diff --git a/README_FR.md b/README_FR.md index 925cd9de..9c9a75dd 100644 --- a/README_FR.md +++ b/README_FR.md @@ -99,6 +99,13 @@ Les guides complets se trouvent dans le centre de documentation MyIP : **[docs.i * [Guide du développeur](https://docs.ipcheck.ing/developer/fr) — déploiement, configuration, architecture et contribution * [Base de connaissances](https://docs.ipcheck.ing/knowledge-base/fr) — utilisation de chaque outil, diagnostic réseau pas à pas, concepts réseau +## 🤝 Contribuer + +Les contributions sont les bienvenues ! Nous maintenons une sélection de tâches adaptées aux débutants — chacune avec les fichiers précis, les critères d'acceptation et des tests pour vous guider : + +* 🏷️ [Good first issues](https://github.com/jason5ng32/MyIP/labels/good%20first%20issue) — ajouter un résolveur DNS de votre pays, enrichir les listes de sites, traduire le README dans votre langue, améliorer les traductions… +* 📄 [CONTRIBUTING.md](CONTRIBUTING.md) — installation, conventions et flux des PR (ciblez la branche `dev`) + ## ⚙️ Configuration Deux réglages comptent avant tout : diff --git a/README_RU.md b/README_RU.md index 996baa30..cb545df1 100644 --- a/README_RU.md +++ b/README_RU.md @@ -99,6 +99,13 @@ docker run -d -p 18966:18966 --name myip --restart always jason5ng32/myip:latest * [Руководство разработчика](https://docs.ipcheck.ing/developer/ru) — развёртывание, настройка, архитектура и участие в разработке * [База знаний](https://docs.ipcheck.ing/knowledge-base/ru) — как пользоваться каждым инструментом, пошаговая диагностика сети, сетевые концепции +## 🤝 Участие в проекте + +Мы рады вашему участию! У нас есть подборка задач для новичков — с точными путями к файлам, критериями приёмки и тестами, которые ведут вас к зелёной сборке: + +* 🏷️ [Good first issues](https://github.com/jason5ng32/MyIP/labels/good%20first%20issue) — добавьте DNS-резолвер своей страны, расширьте подборки сайтов, переведите README на свой язык, улучшите переводы +* 📄 [CONTRIBUTING.md](CONTRIBUTING.md) — настройка окружения, соглашения и процесс PR (PR направляются в ветку `dev`) + ## ⚙️ Конфигурация Прежде всего важны две настройки: diff --git a/README_ZH.md b/README_ZH.md index f347793b..be5ba2dd 100644 --- a/README_ZH.md +++ b/README_ZH.md @@ -99,6 +99,13 @@ docker run -d -p 18966:18966 --name myip --restart always jason5ng32/myip:latest * [开发者指南](https://docs.ipcheck.ing/developer/zh) —— 部署、配置、架构说明与参与贡献 * [知识库](https://docs.ipcheck.ing/knowledge-base/zh) —— 每个工具的使用说明、网络问题排查指南、网络概念科普 +## 🤝 参与贡献 + +欢迎参与贡献!我们维护着一批对新手友好的任务,每条都写明了具体文件、验收标准,并有测试引导你完成: + +* 🏷️ [Good first issues](https://github.com/jason5ng32/MyIP/labels/good%20first%20issue) —— 添加你所在国家的 DNS 解析服务、添加精选网站列表、把 README 翻译成你的语言、润色翻译等 +* 📄 [CONTRIBUTING.md](CONTRIBUTING.md) —— 环境搭建、开发约定与 PR 流程(请将 PR 提交到 `dev` 分支) + ## ⚙️ 配置 开始之前,有两项配置最重要: