Вклад в документацию Project X

Мы приветствуем ваш вклад в документацию Project X и благодарим каждого контрибьютора за помощь! Вы делаете Xray лучше!

Улучшение документации

Документация Project X размещена на GitHubОткрыть в новой вкладке.

Вы можете внести изменения в документацию, выполнив следующие действия:

  1. Откройте репозиторий документации Project XОткрыть в новой вкладке, нажмите кнопку "Fork" в правом верхнем углу, чтобы создать копию репозитория документации в вашей учетной записи GitHub.

  2. Используйте любой удобный инструмент для клонирования документации из вашего репозитория, например:

git clone https://github.com/XTLS/Xray-docs-next.git
  1. Создайте новую ветку на основе ветки main, например:
git checkout -b your-branch

  1. Внесите изменения в новую ветку.

    Примечание: рекомендуем придерживаться Руководства по оформлению текстов на китайском языкеОткрыть в новой вкладке (на китайском).

  2. После внесения изменений отформатируйте их с помощью PrettierОткрыть в новой вкладке.

    Примечание: запросы на включение (PR) с ошибками форматирования могут быть отклонены.

  3. Зафиксируйте изменения и отправьте их в ваш репозиторий:

git push -u origin your-branch

  1. Откройте GitHub, перейдите в раздел "Pull requests" и создайте новый запрос на включение (PR) в репозиторий документации Project XОткрыть в новой вкладке.

  2. В заголовке и описании PR кратко опишите внесенные изменения.

  3. Дождитесь ответа. Если ваш PR будет принят, изменения появятся на сайте документации Project XОткрыть в новой вкладке.

Нашли ошибку?

Если вы обнаружили ошибку в документации, вы можете внести исправления или создать задачу (Issue).