contributing.mdx 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  1. ---
  2. title: Участие в проекте
  3. description: Как внести вклад в 3x-ui и помочь с переводом этой документации.
  4. icon: GitPullRequestArrow
  5. ---
  6. 3x-ui развивается силами сообщества. Мы рады вкладу как в саму панель, так и в
  7. эту документацию.
  8. ## Поддержать разработчика
  9. 3x-ui — бесплатный проект с открытым исходным кодом, который создаётся и
  10. сопровождается открыто. Если он вам полезен, рассмотрите возможность поддержать
  11. дальнейшую разработку:
  12. - **Сделайте пожертвование** на [donate.sanaei.dev](https://donate.sanaei.dev/) —
  13. на странице показаны текущие **цели и задачи** финансирования, в достижении
  14. которых вы можете помочь.
  15. - **Поставьте звезду** [репозиторию](https://github.com/MHSanaei/3x-ui) и
  16. расскажите о проекте.
  17. - **Присоединяйтесь** к Telegram-каналу [@XrayUI](https://t.me/XrayUI), чтобы
  18. следить за новостями и помогать другим.
  19. ## Внести вклад в 3x-ui
  20. - Прочитайте файл `CONTRIBUTING.md` проекта в
  21. [репозитории](https://github.com/MHSanaei/3x-ui).
  22. - Создавайте issue для багов и предложений по новым возможностям с понятными
  23. шагами воспроизведения.
  24. - Используйте Conventional Commits и делайте pull request'ы сфокусированными.
  25. ## Перевести документацию
  26. Этот сайт создан с расчётом на перевод. Контент находится в каталоге
  27. `content/docs/<locale>/` (`en`, `fa`, `ru`, `zh`), а непереведённые страницы
  28. **откатываются к английскому**, поэтому переводить можно постепенно.
  29. <Steps>
  30. <Step>
  31. ### Скопируйте страницу
  32. Скопируйте страницу из `content/docs/en/...` по тому же пути в каталог вашей
  33. локали, например `content/docs/fa/guide/installation.mdx`.
  34. </Step>
  35. <Step>
  36. ### Переводите только текст
  37. Переводите тело страницы и поля frontmatter `title`/`description`. **Не**
  38. переводите код, команды, имена переменных окружения, названия протоколов и
  39. ссылки для подключения.
  40. </Step>
  41. <Step>
  42. ### Учитывайте направление текста
  43. Персидский язык (`fa`) отображается справа налево. Оставляйте блоки кода и ссылки
  44. слева направо (макет уже учитывает это) и проверяйте страницу в обоих
  45. направлениях.
  46. </Step>
  47. </Steps>
  48. <Callout type="info">
  49. Отсутствие страницы в вашей локали — это нормально: она откатывается к
  50. английскому, а не выдаёт ошибку 404. Сначала переводите самые посещаемые
  51. страницы (установка, первый вход, REALITY).
  52. </Callout>