1 В избранное 0 Ответвления 0

OSCHINA-MIRROR/opengauss-docs

Присоединиться к Gitlife
Откройте для себя и примите участие в публичных проектах с открытым исходным кодом с участием более 10 миллионов разработчиков. Приватные репозитории также полностью бесплатны :)
Присоединиться бесплатно
Клонировать/Скачать
CONTRIBUTING.md 7.1 КБ
Копировать Редактировать Web IDE Исходные данные Просмотреть построчно История
gitlife-traslator Отправлено 01.12.2024 18:58 4deb502

Как внести свой вклад

Краткое введение

Прежде чем начать, обратите внимание, что ветка master является версией разработки. Ветка stable, предоставленная для клиентов и пользователей, не принимает никаких коммитов. Все изменения кода должны быть отправлены в ветку master.

Этот репозиторий интегрирован с веб-сайтом, который предоставит окончательный план, поэтому, пожалуйста, поддерживайте только документы в этом репозитории. Всё остальное, например стили и JavaScript, поддерживается на веб-сайте как объединённая тема Hugo.

Содержание организовано с помощью Hugo Book — фреймворка, помогающего создавать собственные книги. Для получения более подробной информации обратитесь к Hugo Book веб-сайт.

Все файлы написаны с использованием синтаксиса Markdown. Обратите внимание: если вы хотите добавить внутренние ссылки, будьте осторожны и указывайте на страницы .html, соответствующие страницам .md папки.

Отладка локально

В этом документе описывается только запуск теста на Linux. Перед выполнением следующих команд подготовьте сервер Linux.

  1. Установите Hugo на сервер. Hugo можно легко установить после того, как будет готов Node.js.
curl -L https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_0.56.3_Linux-64bit.tar.gz | tar -xz && \
    mv hugo /usr/local/bin/
  1. Запустите этот репозиторий локально.
hugo serve --bind 0.0.0.0 --port 80 --baseUrl /

Веб-сайт будет доступен по адресу http://your-server-ip:80.

Отладка с Docker

  1. Создайте образ.
docker build -t docs:v0.0.1 .

Обратите внимание: здесь docs — это имя образа, которое вы можете изменить по своему усмотрению.

  1. Запуск в контейнере.
docker run -p 80:80 -d docs:v0.0.1 > docs.pid

Веб-сайт будет обслуживаться по адресу http://ваш-сервер-ip:80.

  1. Остановите контейнер.
docker rm -f `cat docs.pid` && rm -f docs.pid

Примечание: Язык по умолчанию (en) будет обслуживаться на http://ваш-сервер-ип/. Другой язык (zh) будет обслуживаться на http://ваш-сервер-ип/zh.

Добавить или изменить файл

Перед тем как открыть PR, рекомендуется запустить локальный код и проверить его. Это поможет ускорить слияние ваших коммитов.

Существует два типа файлов Markdown: файлы содержимого, которые находятся в папке content/docs, и файлы меню, которые находятся в папке content/menu. Не забудьте обновить меню при добавлении нового файла.

Примечание: имя домашнего файла меню должно быть home.md.

Получение помощи

  • IRC: TODO
  • Электронная почта: TODO

Сообщение о проблемах

Отличный способ внести свой вклад в проект — отправить подробный отчёт, когда вы столкнётесь с проблемой. Мы всегда ценим хорошо написанные, подробные отчёты об ошибках и предложения функций и будем благодарны вам за это!

Формат проблем

При сообщении о проблемах используйте следующий формат:

  • Это ОТЧЁТ ОБ ОШИБКЕ или ЗАПРОС НА ФУНКЦИЮ?
  • Что произошло?
  • Чего вы ожидали?
  • Что случилось?
  • Как это воспроизвести (как можно меньше и точнее)?
  • Есть ли ещё что-то, что нам нужно знать?
  • Окружение

Подробнее об ISSUE_TEMPLATE.

Отправка запросов на вытягивание

Если вы новичок и ожидаете, что этот проект станет воротами в мир открытого исходного кода, этот учебник — один из лучших вариантов для вас. Просто следуйте инструкциям, и вы получите удовольствие от того, что станете участником.

Шаг 1: Форк репозитория

Прежде чем вносить изменения в этот проект, необходимо убедиться, что он был разветвлён в вашем собственном репозитории. Это означает, что между этим репо и вашим собственным репо будет параллельная разработка, поэтому будьте осторожны, чтобы избежать несогласованности между этими двумя репозиториями.

Шаг 2: Клонируйте удалённый репозиторий

Если вы хотите загрузить код на локальную машину, git — лучший способ:

git clone https://your_repo_url/projectname.git

Шаг 3: Разработайте код локально

Чтобы избежать несогласованности между несколькими ветвями, мы рекомендуем оформить заказ на новую ветку:

git checkout -b new_branch_name origin/master

Затем вы можете произвольно изменить код.

Шаг 4: Отправьте код в удалённый репозиторий

После обновления кода отправьте обновление официальным способом:

git add .
git status (Проверьте статус обновления)
git commit -m "Ваше сообщение"
git push origin new_branch_name

Опубликовать ( 0 )

Вы можете оставить комментарий после Вход в систему

1
https://api.gitlife.ru/oschina-mirror/opengauss-docs.git
git@api.gitlife.ru:oschina-mirror/opengauss-docs.git
oschina-mirror
opengauss-docs
opengauss-docs
master