|
|
|
|
|
# Вклад в документацию 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. Используйте любой удобный инструмент для клонирования документации из вашего репозитория, например:
|
|
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
git clone https://github.com/XTLS/Xray-docs-next.git
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
3. Создайте новую ветку на основе ветки `main`, например:
|
|
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
git checkout -b your-branch
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
4. Внесите изменения в новую ветку.
|
|
|
|
|
|
|
|
|
|
|
|
Примечание: рекомендуем придерживаться [Руководства по оформлению текстов на китайском языке](https://github.com/sparanoid/chinese-copywriting-guidelines) (на китайском).
|
|
|
|
|
|
|
|
|
|
|
|
5. После внесения изменений отформатируйте их с помощью [Prettier](https://prettier.io/docs/en/install.html).
|
|
|
|
|
|
|
|
|
|
|
|
Примечание: запросы на включение (PR) с ошибками форматирования могут быть отклонены.
|
|
|
|
|
|
|
|
|
|
|
|
6. Зафиксируйте изменения и отправьте их в ваш репозиторий:
|
|
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
git push -u origin your-branch
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
7. Откройте GitHub, перейдите в раздел "Pull requests" и создайте новый запрос на включение (PR) в [репозиторий документации Project X](https://github.com/XTLS/Xray-docs-next).
|
|
|
|
|
|
|
|
|
|
|
|
8. В заголовке и описании PR кратко опишите внесенные изменения.
|
|
|
|
|
|
|
|
|
|
|
|
9. Дождитесь ответа. Если ваш PR будет принят, изменения появятся на [сайте документации Project X](https://xtls.github.io).
|
|
|
|
|
|
|
|
|
|
|
|
## Нашли ошибку?
|
|
|
|
|
|
|
|
|
|
|
|
Если вы обнаружили ошибку в документации, вы можете внести исправления или создать задачу (Issue).
|
|
|
|
|
|
|
|
|
|
|
|
|
