[May 25, 2021] Adding documentation around comment resolution branch protection rule (#19381)

This commit is contained in:
Kevin Sun 2021-05-25 10:35:46 -07:00 коммит произвёл GitHub
Родитель 6bd02c44c6
Коммит b37a34c953
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
6 изменённых файлов: 22 добавлений и 0 удалений

Двоичные данные
assets/images/help/pull_requests/conversations-menu.png Normal file

Двоичный файл не отображается.

После

Ширина:  |  Высота:  |  Размер: 64 KiB

Двоичные данные
assets/images/help/repository/require-conversation-resolution.png Normal file

Двоичный файл не отображается.

После

Ширина:  |  Высота:  |  Размер: 50 KiB

Двоичный файл не отображается.

До

Ширина:  |  Высота:  |  Размер: 16 KiB

После

Ширина:  |  Высота:  |  Размер: 13 KiB

Просмотреть файл

@ -40,6 +40,8 @@ By default, the restrictions of a branch protection rule don't apply to people w
For each branch protection rule, you can choose to enable or disable the following settings.
- [Require pull request reviews before merging](#require-pull-request-reviews-before-merging)
- [Require status checks before merging](#require-status-checks-before-merging)
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" %}
- [Require conversation resolution before merging](#require-conversation-resolution-before-merging){% endif %}
- [Require signed commits](#require-signed-commits)
- [Require linear history](#require-linear-history)
- [Include administrators](#include-administrators)
@ -96,6 +98,12 @@ You can set up required status checks to either be "loose" or "strict." The type
For troubleshooting information, see "[Troubleshooting required status checks](/github/administering-a-repository/troubleshooting-required-status-checks)."
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" %}
#### Require conversation resolution before merging
Requires all comments on the pull request to be resolved before it can be merged to a protected branch. This ensures that all comments are addressed or acknowledged before merge.
{% endif %}
#### Require signed commits
When you enable required commit signing on a branch, contributors {% if currentVersion == "free-pro-team@latest" %}and bots{% endif %} can only push commits that have been signed and verified to the branch. For more information, see "[About commit signature verification](/articles/about-commit-signature-verification)."

Просмотреть файл

@ -65,6 +65,10 @@ When you create a branch rule, the branch you specify doesn't have to exist yet
![Loose or strict required status checkbox](/assets/images/help/repository/protecting-branch-loose-status.png)
- From the list of available status checks, select the checks you want to require.
![List of available status checks](/assets/images/help/repository/required-statuses-list.png)
{%- if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" %}
1. Optionally, select **Require conversation resolution before merging**.
![Require conversation resolution before merging option](/assets/images/help/repository/require-conversation-resolution.png)
{%- endif %}
1. Optionally, select **Require signed commits**.
![Require signed commits option](/assets/images/help/repository/require-signed-commits.png)
1. Optionally, select **Require linear history**.

Просмотреть файл

@ -11,3 +11,13 @@ The entire conversation will be collapsed and marked as resolved, making it easi
![Resolved conversation](/assets/images/help/pull_requests/resolved-conversation.png)
If the suggestion in a comment is out of your pull request's scope, you can open a new issue that tracks the feedback and links back to the original comment. For more information, see "[Opening an issue from a comment](/github/managing-your-work-on-github/opening-an-issue-from-a-comment)."
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" %}
#### Discovering and navigating conversations
You can discover and navigate to all the conversations in your pull request using the **Conversations** menu that's shown at the top of the **Files Changed** tab.
From this view, you can see which conversations are unresolved, resolved, and outdated. This makes it easy to discover and resolve conversations.
![Showing the conversations menu](/assets/images/help/pull_requests/conversations-menu.png)
{% endif %}