Улучшение этой документации
Благодарим вас за интерес к этой документации!
- Внесение изменений с помощью GitHub
- Внесение изменений с помощью Git
- Как форматировать статью с помощью Markdown
- Соглашения о разметке & правила специально для этого репозитория
- Вопросы и ответы
- Дополнительные ресурсы
Используйте GitHub, чтобы внести свой вклад в эту документацию без необходимости клонировать репозиторий на рабочий стол. Это самый простой способ создания запроса на вытягивание в этом репозитории. Используйте этот метод для внесения незначительных изменений, не связанных с изменениями кода. Использование этого метода позволяет вносить вклад в одну статью за раз.
- Найдите статью, в которой вы хотите внести свой вклад, на сайте GitHub.
- Перейдя в статью на GitHub, войдите в GitHub (получите бесплатную учетную запись Присоединиться к GitHub).
- Выберите значок карандаша (отредактируйте файл в вилке этого проекта) и внесите изменения в <>окне Изменение файла .
- Прокрутите вниз и введите описание.
- Выберите Предложить изменение> файлаСоздать запрос на вытягивание.
Вы успешно отправили запрос на вытягивание. Запросы на вытягивание обычно проверяются в течение 10 рабочих дней.
Используйте Git для внесения существенных изменений, таких как:
- Добавленный код.
- Внесение изменений, влияющих на смысл.
- Внесение больших изменений в текст.
- Добавление новых разделов.
Если у вас нет учетной записи GitHub, настройте ее на сайте GitHub.
После создания учетной записи установите Git на компьютере. Выполните действия, описанные в учебнике [Настройка Git].
Чтобы отправить запрос на вытягивание с помощью Git, выполните действия, описанные в статье Использование GitHub, Git и этого репозитория.
Вам будет предложено подписать лицензионное соглашение участника, если вы:
- Участник группы Microsoft Open Technologies.
- Участник, который не работает в корпорации Майкрософт.
Как участник сообщества, вы должны подписать лицензионное соглашение на участие (CLA), прежде чем вы сможете вносить большие отправки в проект. Необходимо заполнить и отправить документацию только один раз. Внимательно просмотрите документ. Может потребоваться подпись вашего работодателя.
Подписывание CLA не дает вам прав на фиксацию в репозитории main, но это означает, что команды разработчиков Office и разработчиков содержимого Office смогут просматривать и утверждать ваши взносы. Вам зачисляются заявки.
Запросы на вытягивание обычно проверяются в течение 10 рабочих дней.
Примечание
Большую часть информации в этом разделе можно найти в статьях [справка GitHub]. Если вы знакомы с Git и GitHub, перейдите к разделу Участие и изменение содержимого , чтобы узнать о потоке кода и содержимого этого репозитория.
Чтобы добавлять информацию в этот проект, настройте учетную запись GitHub. Если вы еще не сделали этого, перейдите на сайт GitHub и сделайте это сейчас.
Установите Git на компьютере. Выполните действия, описанные в учебнике [Настройка Git].
Создайте свое ответвление этого репозитория. Для этого в верхней части страницы нажмите вилку .
Скопируйте вилку на компьютер. Для этого откройте Git Bash. Введите в командной строке следующую команду:
git clone https://github.com/<your user name>/<repo name>.git
Затем создайте ссылку на корневой репозиторий с помощью следующих команд:
cd <repo name>
git remote add upstream https://github.com/OfficeDev/<repo name>.git
git fetch upstream
Поздравляем! Теперь вы настроили репозиторий. Повторять эти действия больше не нужно.
Чтобы сделать процесс внесения вклада как можно более простым, выполните следующие действия.
- Создайте новую ветвь.
- Добавьте или отредактируйте содержимое.
- Отправьте запрос на включение внесенных изменений в основной репозиторий.
- Удалите ветвь.
Важно! Ограничьте каждую ветвь одной концепцией или статьей, чтобы упростить рабочий процесс и снизить вероятность конфликтов слияния. Содержимое, подходящее для новой ветви, включает:
- Новая статья.
- Редактирование правописания и грамматики.
- Применение одного изменения форматирования к большому набору статей (например, применение нового нижнего колонтитула авторских прав).
- Откройте Git Bash.
- В командной строке Git Bash введите
git pull upstream main:<new branch name>
. При этом локально создается новая ветвь, которая копируется из последней main ветви OfficeDev. - В командной строке Git Bash введите
git push origin <new branch name>
. Это оповещает GitHub о новой ветви. Новая ветвь появится в вашем ответвлении репозитория на сайте GitHub. - В командной строке Git Bash введите
git checkout <new branch name>
, чтобы переключиться на новую ветвь.
Перейдите к репозиторию на компьютере с помощью проводник. Файлы репозитория находятся в C:\Users\<yourusername>\<repo name>
.
Чтобы изменить файлы, откройте их в выбранном редакторе и измените их. Чтобы создать новый файл, используйте выбранный редактор и сохраните новый файл в соответствующем расположении в локальной копии репозитория. Во время работы часто сохраняйте свою работу.
Файлы в C:\Users\<yourusername>\<repo name>
являются рабочей копией новой ветви, созданной в локальном репозитории. Изменение файлов в этой папке не влияет на локальный репозиторий, пока вы не сохраните изменение. Чтобы сохранить изменение в локальном репозитории, введите следующие команды в GitBash:
git add .
git commit -v -a -m "<Describe the changes made in this commit>"
Команда add
добавляет изменения в область промежуточного хранения для подготовки к сохранению в репозитории. Период после add
выполнения команды указывает, что вы хотите выполнить этап всех добавленных или измененных файлов, рекурсивно проверяя вложенные папки. (Если вы не хотите фиксировать все изменения, можно добавить определенные файлы. Вы также можете отменить фиксацию. Для получения справки введите git add -help
или git status
.)
Команда commit
применяет промежуточные изменения в репозитории. Параметр -m
означает, что вы предоставляете комментарий к фиксации в командной строке. Параметры -v и -a можно опустить. Параметр -v предназначен для подробных выходных данных из команды, а -a выполняет то, что вы уже сделали с помощью команды add.
Вы можете зафиксировать несколько раз во время выполнения работы или один раз, когда закончите.
Завершив работу и подготовив ее к слиянию с репозиторием main, выполните следующие действия.
- В командной строке Git Bash введите
git push origin <new branch name>
.origin
— это репозиторий GitHub, с которого вы скопировали свой локальный репозиторий. Эта команда передает текущее состояние новой ветви, в том числе все изменения, сохраненные на предыдущих шагах, в вашем ответвлении GitHub. - На сайте GitHub перейдите к новой ветви в своем ответвлении.
- Нажмите кнопку Запрос на вытягивание в верхней части страницы.
- Убедитесь, что базовая ветвь имеет значение
OfficeDev/<repo name>@main
, а головная ветвь —<your username>/<repo name>@<branch name>
. - Нажмите кнопку Обновить диапазон фиксации .
- Добавьте заголовок в запрос на вытягивание и опишите все внесенные изменения.
- Отправьте запрос на включение внесенных изменений.
Один из администраторов сайта обработает запрос на вытягивание. Запрос на вытягивание появится на сайте Имени OfficeDev или репозитория в разделе Проблемы. Когда запрос на вытягивание будет принят, проблема будет устранена.
После успешного слияния ветви (т. е. ваш запрос на вытягивание принят), не продолжайте работать в этой локальной ветви. Это может привести к конфликтам слияния при отправке другого запроса на вытягивание. Чтобы выполнить другое обновление, создайте новую локальную ветвь из успешно объединенной вышестоящая ветвь, а затем удалите исходную локальную ветвь.
Например, если локальная ветвь X успешно объединена с OfficeDev/microsoft-graph-docs main ветвью, и вы хотите внести дополнительные обновления в объединенное содержимое. Создайте новую локальную ветвь X2 из officeDev/microsoft-graph-docs main ветви. Для этого откройте GitBash и выполните следующие команды:
cd microsoft-graph-docs
git pull upstream main:X2
git push origin X2
Теперь у вас есть локальные копии (в новой локальной ветви) работы, отправленной в ветви X. Ветвь X2 также содержит все работы, объединенные другими средствами записи, поэтому, если ваша работа зависит от работы других пользователей (например, общих образов), она доступна в новой ветви. Вы можете убедиться, что предыдущая работа (и работа других пользователей) находится в ветви, проверив новую ветвь...
git checkout X2
…и проверив ее содержимое. (Команда checkout
обновляет файлы в C:\Users\<yourusername>\microsoft-graph-docs
до текущего состояния ветви X2.) После проверка новую ветвь можно обновить содержимое и зафиксировать их как обычно. Однако во избежание работы в объединенной ветви (X) рекомендуем удалить ее (см. раздел Удаление ветви ниже).
После успешного объединения изменений в репозиторий main удалите используемую ветвь, так как она больше не нужна. Любая дополнительная работа должна выполняться в новой ветви.
- В командной строке Git Bash введите
git checkout main
. Это гарантирует, что вы не работаете в удаляемой ветви (это не допускается). - Затем в командной строке введите
git branch -d <branch name>
. При этом ветвь на компьютере удаляется только в том случае, если она успешно объединена с репозиторием вышестоящий. (Вы можете переопределить это правило с помощью флага–D
, но для начала убедитесь, что это необходимо.) - Наконец, введите в командной строке команду
git push origin :<branch name>
(с пробелом перед двоеточием и без пробела после него). При этом ветвь будет удалена из вашего ответвления GitHub.
Поздравляем, вы успешно внесли свой вклад в проект!
Во всех статьях в этом репозитории используется Markdown. Полное введение (и список всех синтаксисов) можно найти в [Daring Fireball - Markdown].
Ознакомьтесь с документацией по Markdown в нашем руководстве по участник.
Заполните форму на странице Join GitHub, чтобы создать бесплатную учетную запись GitHub.
Вам автоматически будет отправлено уведомление о том, что вам нужно подписать лицензионное соглашение участника (CLA), если он требуется для запроса на вытягивание.
Вам нужно подписать лицензионное соглашение с участником (CLA), прежде чем вы сможете вносить большие изменения в этот проект. Вам нужно заполнить и отправить документ всего один раз. Внимательно просмотрите документ. Может потребоваться подпись вашего работодателя.
При отправке изменений с помощью запроса на вытягивание наша команда получит уведомление и рассмотрит ваш запрос на вытягивание. Вы получите уведомления о запросе на вытягивание из GitHub; Вы также можете получить уведомление от кого-то из нашей команды, если нам нужна дополнительная информация. Если ваш запрос на вытягивание утвержден, мы обновим документацию. Мы оставляем за собой право изменить вашу отправку для юридических вопросов, вопросов стиля, ясности или других вопросов.
В настоящее время мы не разрешаем внешним участникам утверждать запросы на вытягивание в этом репозитории.
Запросы на вытягивание обычно проверяются в течение 10 рабочих дней.
- Чтобы узнать больше о Markdown, перейдите на сайт создателя Markdown [Daring Fireball].
- Чтобы узнать больше об использовании Git и GitHub, сначала проверка [справка GitHub].
GitHub HomeGitHub Справкапо настройке GitDaring Fireball - MarkdownDaring Fireball