2.8 KiB
Вклад в документацию Project X
Мы приветствуем ваш вклад в документацию Project X и благодарим каждого контрибьютора за помощь! Вы делаете Xray лучше!
Улучшение документации
Документация Project X размещена на GitHub.
Вы можете внести изменения в документацию, выполнив следующие действия:
-
Откройте репозиторий документации Project X, нажмите кнопку "Fork" в правом верхнем углу, чтобы создать копию репозитория документации в вашей учетной записи GitHub.
-
Используйте любой удобный инструмент для клонирования документации из вашего репозитория, например:
git clone https://github.com/XTLS/Xray-docs-next.git
- Создайте новую ветку на основе ветки
main
, например:
git checkout -b your-branch
-
Внесите изменения в новую ветку.
Примечание: рекомендуем придерживаться Руководства по оформлению текстов на китайском языке (на китайском).
-
После внесения изменений отформатируйте их с помощью Prettier.
Примечание: запросы на включение (PR) с ошибками форматирования могут быть отклонены.
-
Зафиксируйте изменения и отправьте их в ваш репозиторий:
git push -u origin your-branch
-
Откройте GitHub, перейдите в раздел "Pull requests" и создайте новый запрос на включение (PR) в репозиторий документации Project X.
-
В заголовке и описании PR кратко опишите внесенные изменения.
-
Дождитесь ответа. Если ваш PR будет принят, изменения появятся на сайте документации Project X.
Нашли ошибку?
Если вы обнаружили ошибку в документации, вы можете внести исправления или создать задачу (Issue).