Skip to content

Commit 4dc044d

Browse files
authored
Merge pull request #39971 from github/repo-sync
Repo sync
2 parents 8d97af0 + a311354 commit 4dc044d

38 files changed

+1836
-284
lines changed

content/actions/reference/workflows-and-actions/events-that-trigger-workflows.md

Lines changed: 62 additions & 114 deletions
Large diffs are not rendered by default.
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
title: Responsible use of GitHub Copilot commit message generation
3+
shortTitle: Commit message generation
4+
allowTitleToDifferFromFilename: true
5+
intro: 'Learn how to use {% data variables.product.prodname_copilot_short %} commit message generation responsibly by understanding its purposes, capabilities, and limitations.'
6+
versions:
7+
feature: copilot
8+
topics:
9+
- Copilot
10+
contentType: rai
11+
---
12+
13+
## About {% data variables.product.prodname_copilot_short %} commit message generation
14+
15+
{% data variables.product.prodname_copilot_short %} commit message generation is an AI-powered feature that allows you to create a commit message summary (title) and description based on the changes you've selected to commit in {% data variables.product.prodname_dotcom_the_website %}. To learn about commit message generation in {% data variables.product.prodname_desktop %}, see [AUTOTITLE](/copilot/responsible-use/copilot-in-github-desktop).
16+
17+
When users commit changes to files using {% data variables.product.github %}'s web interface, {% data variables.product.prodname_copilot_short %} scans through the code changes and provides a suggested summary (title) and description of the changes made in prose. You can review and edit {% data variables.product.prodname_copilot_short %}'s suggested title and description **before** committing the changes to a branch.
18+
19+
The only supported language for {% data variables.product.prodname_copilot_short %}-generated commit messages in {% data variables.product.prodname_dotcom_the_website %} is English.
20+
21+
{% data variables.product.prodname_copilot_short %} commit message generation uses a simple-prompt flow leveraging the {% data variables.product.prodname_copilot_short %} API, utilizing the generic large language model and no additional trained models.
22+
23+
When you click on the **Commit changes** button in {% data variables.product.prodname_dotcom_the_website %}, a call is generated to the {% data variables.product.prodname_copilot_short %} API to generate suggested text to insert into the summary and description boxes. The text complete request includes information from the selected changes in the different files of the repository in a prompt that requests {% data variables.product.prodname_copilot_short %} to generate a suggestion for a commit message that accurately describes those changes. The response is then used to fill the summary and description boxes. You can then review the suggested message, edit it if needed, and then make a commit with it.
24+
25+
## Use cases for {% data variables.product.prodname_copilot_short %} commit message generation
26+
27+
{% data variables.product.prodname_copilot_short %} commit message generation aims to streamline the author workflow so that they can save time and maintain clear commit histories when summarizing their changes. For many users, this could be helpful for saving time when committing large changes. Authors can review and edit suggestions before finalizing and manually committing the changes to a branch. The feature is integrated seamlessly into the commit workflow for a smoother experience.
28+
29+
## Improving {% data variables.product.prodname_copilot_short %} commit message generation
30+
31+
To enhance the experience and address some of the limitations of {% data variables.product.prodname_copilot_short %} commit message generation, there are various measures that you can adopt. For more information about the limitations, see [Limitations of {% data variables.product.prodname_copilot_short %} commit message generation](#limitations-of-copilot-commit-message-generation).
32+
33+
### Use {% data variables.product.prodname_copilot_short %} commit message generation as a tool, not a replacement
34+
35+
The feature is intended to supplement rather than replace a human's work to draft commit messages. The quality of the commit message suggestions will depend on the quality of the code changes and the context in the changed files. It remains your responsibility to review and assess the accuracy of information in the commits you create.
36+
37+
### Provide feedback
38+
39+
If you encounter any issues or limitations with {% data variables.product.prodname_copilot_short %} commit message generation, you can provide feedback via the [community discussion](https://github.com/orgs/community/discussions/categories/copilot-news-and-announcements). This can help the developers to improve the tool and address any concerns or limitations.
40+
41+
## Limitations of {% data variables.product.prodname_copilot_short %} commit message generation
42+
43+
Depending on factors such as your operating system and input data, you may encounter different levels of accuracy when using {% data variables.product.prodname_copilot_short %} commit message generation in {% data variables.product.prodname_dotcom_the_website %}. The following information is designed to help you understand system limitations and key concepts about performance as they apply to {% data variables.product.prodname_copilot_short %} commit message generation.
44+
45+
### Limited scope
46+
47+
{% data variables.product.prodname_copilot_short %} commit message generation operates within defined boundaries and might struggle with intricate code changes, short diff windows, or recently developed programming languages. The quality of suggestions it provides can be influenced by the availability and diversity of training data. For instance, inquiries about well-documented languages like Python may yield more accurate responses compared to questions about less popular languages.
48+
49+
### Inaccurate responses
50+
51+
The more inputs and context that {% data variables.product.prodname_copilot_short %} can learn from, the better the outputs will become. However, since the feature is quite new, it will take time to reach exact precision with the summaries that are generated. In the meantime, there may be cases where a generated summary is less accurate and requires the user to make modifications before saving and publishing their commit. In addition, there is a risk of "hallucination," where {% data variables.product.prodname_copilot_short %} generates statements that are inaccurate. For these reasons, reviewing is a requirement, and careful review of the output is highly recommended by our team.
52+
53+
### Replication of commit message content
54+
55+
Because a commit message is a summary of the changes that were made in a repository, there is potential for the summary to include harmful or offensive terms if any are within the content of the changes.
56+
57+
### Potential biases and errors
58+
59+
Training data for {% data variables.product.prodname_copilot_short %} commit message generation is sourced from existing online sources. It’s important to note that these sources may include biases and errors of the individuals who contributed to the training data. {% data variables.product.prodname_copilot_short %} commit message generation may inadvertently perpetuate these biases and errors.
60+
61+
## Opt out
62+
63+
Users wishing to opt out of {% data variables.product.prodname_copilot_short %} commit message generation can do so via the {% data variables.product.prodname_copilot_short %} [settings page](https://github.com/settings/copilot/features) in {% data variables.product.prodname_dotcom_the_website %}.
64+
65+
## Further reading
66+
67+
* [AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-terms-for-additional-products-and-features#github-copilot)
68+
* [{% data variables.product.prodname_copilot %} Trust Center](https://copilot.github.trust.page/)

content/copilot/responsible-use/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ children:
1616
- /copilot-in-github-desktop
1717
- /pull-request-summaries
1818
- /copilot-text-completion
19+
- /copilot-commit-message-generation
1920
- /code-review
2021
- /copilot-coding-agent
2122
- /spark

content/issues/planning-and-tracking-with-projects/learning-about-projects/best-practices-for-projects.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,9 @@ You can use {% data variables.product.prodname_projects_v2 %} to manage your wor
2121

2222
Breaking a large issue into smaller issues makes the work more manageable and enables team members to work in parallel. It also leads to smaller pull requests, which are easier to review.
2323

24-
To track how smaller issues fit into the larger goal, milestones, or labels. For more information, see [AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/about-milestones) and [AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/managing-labels).
24+
To ensure efficient progress, clearly define which issues are blocked by, or blocking, other issues. See [AUTOTITLE](/free-pro-team@latest/issues/tracking-your-work-with-issues/using-issues/creating-issue-dependencies).
25+
26+
To track how smaller issues fit into the larger goal, use milestones or labels. For more information, see [AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/about-milestones) and [AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/managing-labels).
2527

2628
## Communicate
2729

content/issues/tracking-your-work-with-issues/about-issues.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,10 @@ Issues can be created in a variety of ways, so you can choose the most convenien
3535

3636
{% endif %}
3737

38+
## About issue dependencies
39+
40+
You can define blocking relationships between issues using issue dependencies. Issue dependencies let you identify issues that are blocked by, or blocking, other work. See [AUTOTITLE](/free-pro-team@latest/issues/tracking-your-work-with-issues/using-issues/creating-issue-dependencies).
41+
3842
## About integration with {% data variables.product.github %}
3943

4044
Issues integrate with your work all across {% data variables.product.github %}. Mentioning an issue in another issue or pull request will create references between them and using keywords, like `fixes:`, in your pull requests will automatically close the associated issues. See [AUTOTITLE](/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue).

content/issues/tracking-your-work-with-issues/configuring-issues/planning-and-tracking-work-for-your-team-or-project.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,10 @@ Below we have added a task list to our Project Octocat issue, breaking it down i
9292

9393
{% endif %}
9494

95+
### Showing which issues are blocked by, or blocking, other work
96+
97+
By creating issue dependencies, you can easily see and communicate which issues are blocked by, or blocking, other issues. This helps streamline coordination, prevent bottlenecks and increase transparency across the team. See [AUTOTITLE](/free-pro-team@latest/issues/tracking-your-work-with-issues/using-issues/creating-issue-dependencies).
98+
9599
{% ifversion copilot %}
96100

97101
## Understanding new issues
@@ -175,7 +179,7 @@ You can also use the existing {% data variables.product.prodname_projects_v1 %}
175179

176180
Below is a {% data variables.projects.projects_v1_board %} for our example Project Octocat with the issue we created, and the smaller issues we broke it down into, added to it.
177181

178-
![Screenshot of a {% data variables.projects.projects_v1_board %} called "Project Octocat Board," with issues organized into columns for "To do", "In progress," and "Done."](/assets/images/help/issues/quickstart-project-board.png)
182+
![Screenshot of a {% data variables.projects.projects_v1_board %} called "Project Octocat Board," with issues organized into columns for "To do," "In progress," and "Done."](/assets/images/help/issues/quickstart-project-board.png)
179183

180184
{% endif %}
181185

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
title: Creating issue dependencies
3+
intro: 'Learn how to create issue dependencies so that you can see which issues are blocked by, or blocking, other work.'
4+
versions:
5+
fpt: '*'
6+
ghec: '*'
7+
type: overview
8+
topics:
9+
- Project management
10+
permissions: 'People with at least triage permissions for a repository can create issue dependencies.'
11+
product: 'Issue dependencies are available for users on {% data variables.product.prodname_free_user %}, {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, and {% data variables.product.prodname_ghe_cloud %} plans.'
12+
---
13+
14+
{% data reusables.issues.issue-dependencies-preview-note %}
15+
16+
Issue dependencies let you define issues that are blocked by, or blocking, other work.
17+
18+
## Marking an issue as blocked by, or blocking, another issue
19+
20+
1. Navigate to the issue that you want to create a dependency for.
21+
1. In the right sidebar, click **Relationships**.
22+
1. From the dropdown, select a dependency option:
23+
* To indicate that your issue depends on another issue being completed, select **Mark as blocked by**.
24+
* To indicate that your issue is preventing another issue from being completed, select **Mark as blocking**.
25+
1. In the dialog box that opens, search for and select all the issues that are blocked by, or blocking, your issue.
26+
27+
Blocked issues are marked with a "Blocked" icon on your project boards or repository's Issues page, so you can easily identify bottlenecks.
28+
29+
## Removing a blocking relationship between two issues
30+
31+
1. Navigate to the issue that you want to remove a dependency from.
32+
1. In the right sidebar, click **Relationships**.
33+
1. From the dropdown, select a dependency option:
34+
* To indicate that your issue no longer depends on another issue being completed, select **Change blocked by**.
35+
* To indicate that your issue is no longer preventing another issue from being completed, select **Change blocking**.
36+
1. In the dialog box that opens, deselect the issues that are no longer blocked by, or blocking, your issue.

content/issues/tracking-your-work-with-issues/using-issues/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ topics:
1010
children:
1111
- /creating-an-issue
1212
- /adding-sub-issues
13+
- /creating-issue-dependencies
1314
- /assigning-issues-and-pull-requests-to-other-github-users
1415
- /editing-an-issue
1516
- /viewing-all-of-your-issues-and-pull-requests
Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1 @@
1-
> [!NOTE]
2-
> This event will only trigger a workflow run if the workflow file exists on the default branch.
1+
This event will only trigger a workflow run if the workflow file exists on the default branch.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
> [!NOTE] Issue dependencies are in public preview and subject to change.

0 commit comments

Comments
 (0)