mirror of
https://github.com/XTLS/Xray-docs-next.git
synced 2026-09-26 00:08:03 +03:00
61 lines
3.9 KiB
Markdown
61 lines
3.9 KiB
Markdown
# Вклад в документацию Project X
|
||
|
||
Добро пожаловать в команду участников документации 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.
|
||
|
||
2. Простые правки можно внести прямо на веб-сайте GitHub.<br>
|
||
Однако для сложных изменений обязательно используйте VSCode. Склонируйте документацию из вашего форка, например:
|
||
|
||
```bash
|
||
git clone https://github.com/ваше-имя-пользователя/Xray-docs-next.git
|
||
```
|
||
|
||
3. Создайте новую ветку на основе ветки `main`, например:
|
||
|
||
```bash
|
||
git checkout -b your-branch
|
||
```
|
||
|
||
4. Внесите изменения в новой ветке.
|
||
|
||
Примечание: Рекомендуется использовать автоформатирование [prettier](https://prettier.io/docs/install), а также придерживаться [информационного стиля (Главред)](https://glvrd.ru/) для ясности текста.
|
||
|
||
5. После завершения редактирования плагин VSCode автоматически отформатирует ваши изменения. В этом репозитории уже предварительно настроены все необходимые плагины для VSCode; вам нужно лишь установить их одним нажатием, следуя подсказкам VSCode.
|
||
|
||
Примечание: PR с проблемами форматирования могут быть отклонены.
|
||
|
||
6. Зафиксируйте (commit) изменения и отправьте (push) их в свой репозиторий:
|
||
|
||
```bash
|
||
git push -u origin your-branch
|
||
```
|
||
|
||
7. Откройте GitHub и нажмите **'Pull request'**, чтобы отправить PR в [репозиторий документации Project X](https://github.com/XTLS/Xray-docs-next).
|
||
|
||
8. Пожалуйста, в заголовке и тексте PR кратко опишите добавленный или измененный контент.
|
||
|
||
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.
|