Max/XTLS_Xray-docs-next
1
0
Fork 0
mirror of https://github.com/XTLS/Xray-docs-next.git synced 2026-09-29 02:18:06 +03:00
Code Issues Packages Projects Releases Wiki Activity

Contributing to Project X Documentation

Browse Source
This commit is contained in:
Meow
2026-01-24 06:36:58 +08:00
parent 52f9eac084
commit 59bb98311e
3 changed files with 110 additions and 68 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/ru/document/document.md
+35 -22
View File
@@ -1,47 +1,60 @@
# Вклад в документацию Project X
Мы приветствуем ваш вклад в документацию Project X и благодарим каждого контрибьютора за помощь! Вы делаете Xray лучше!
Добро пожаловать в команду участников документации Project X. Мы ценим вклад каждого контрибьютора! Именно вы делаете Xray мощнее!
## Улучшение документации
Документация Project X размещена на [GitHub](https://github.com/XTLS/Xray-docs-next).
Вы можете внести изменения в документацию, выполнив следующие действия:
Вы можете внести свои изменения в документацию, выполнив следующие шаги:
1. Откройте [репозиторий документации Project X](https://github.com/XTLS/Xray-docs-next), нажмите кнопку "Fork" в правом верхнем углу, чтобы создать копию репозитория документации в вашей учетной записи GitHub.
1. Откройте [репозиторий документации Project X](https://github.com/XTLS/Xray-docs-next) и нажмите **Fork** в правом верхнем углу, чтобы создать копию репозитория (зеркало) в вашем аккаунте GitHub.
2. Используйте любой удобный инструмент для клонирования документации из вашего репозитория, например:
2. Простые правки можно внести прямо на веб-сайте GitHub.<br>
Однако для сложных изменений обязательно используйте VSCode. Склонируйте документацию из вашего форка, например:
```
git clone https://github.com/XTLS/Xray-docs-next.git
```
```bash
git clone [https://github.com/ваше-имя-пользователя/Xray-docs-next.git](https://github.com/ваше-имя-пользователя/Xray-docs-next.git)
```
3. Создайте новую ветку на основе ветки `main`, например:
```
git checkout -b your-branch
```
```bash
git checkout -b your-branch
```
4. Внесите изменения в новую ветку.
4. Внесите изменения в новой ветке.
Примечание: рекомендуем придерживаться [Руководства по оформлению текстов на китайском языке](https://github.com/sparanoid/chinese-copywriting-guidelines) (на китайском).
Примечание: Рекомендуется использовать автоформатирование [prettier](https://prettier.io/docs/install), а также придерживаться [информационного стиля (Главред)](https://glvrd.ru/) для ясности текста.
5. После внесения изменений отформатируйте их с помощью [Prettier](https://prettier.io/docs/en/install.html).
5. После завершения редактирования плагин VSCode автоматически отформатирует ваши изменения. В этом репозитории уже предварительно настроены все необходимые плагины для VSCode; вам нужно лишь установить их одним нажатием, следуя подсказкам VSCode.
Примечание: запросы на включение (PR) с ошибками форматирования могут быть отклонены.
Примечание: PR с проблемами форматирования могут быть отклонены.
6. Зафиксируйте изменения и отправьте их в ваш репозиторий:
6. Зафиксируйте (commit) изменения и отправьте (push) их в свой репозиторий:
```
git push -u origin your-branch
```
```bash
git push -u origin your-branch
```
7. Откройте GitHub, перейдите в раздел "Pull requests" и создайте новый запрос на включение (PR) в [репозиторий документации Project X](https://github.com/XTLS/Xray-docs-next).
7. Откройте GitHub и нажмите **'Pull request'**, чтобы отправить PR в [репозиторий документации Project X](https://github.com/XTLS/Xray-docs-next).
8. В заголовке и описании PR кратко опишите внесенные изменения.
8. Пожалуйста, в заголовке и тексте PR кратко опишите добавленный или измененный контент.
9. Дождитесь ответа. Если ваш PR будет принят, изменения появятся на [сайте документации Project X](https://xtls.github.io).
9. Ожидайте ответа. Если PR будет принят (merge), ваши изменения появятся непосредственно на [сайте документации Project X](https://xtls.github.io).
10. Хотите предварительно просмотреть полный результат локально?
1. Установите [Node.JS](https://nodejs.org/en/download)
2. Установите [pnpm](https://pnpm.io/installation)
3. Перезапустите VSCode и откройте этот проект
4. Нажмите `Ctrl` + `` ` `` чтобы открыть встроенный терминал VSCode
5. Запустите следующие команды в терминале:
```bash
pnpm install
pnpm run docs:dev
```
## Нашли ошибку?
Если вы обнаружили ошибку в документации, вы можете внести исправления или создать задачу (Issue).
Если вы обнаружили ошибку в документации, вы можете улучшить её самостоятельно или создать Issue.