[Improvement]: Add Copilot prompts to leverage Copilot to draft discussions/writeups (#54850)
This commit is contained in:
@@ -12,4 +12,5 @@ children:
|
|||||||
- /explaining-legacy-code
|
- /explaining-legacy-code
|
||||||
- /explaining-complex-algorithms-or-logic
|
- /explaining-complex-algorithms-or-logic
|
||||||
- /syncing-documentation-with-code-changes
|
- /syncing-documentation-with-code-changes
|
||||||
|
- /writing-discussions-or-blog-posts
|
||||||
---
|
---
|
||||||
|
|||||||
@@ -0,0 +1,100 @@
|
|||||||
|
---
|
||||||
|
title: Writing discussions or blog posts
|
||||||
|
shortTitle: Write discussions or blog posts
|
||||||
|
intro: '{% data variables.product.prodname_copilot_chat_short %} can help you generate ideas, outline, or draft discussions or blog posts.'
|
||||||
|
versions:
|
||||||
|
feature: copilot
|
||||||
|
category:
|
||||||
|
- 'Documenting code'
|
||||||
|
complexity:
|
||||||
|
- Simple
|
||||||
|
octicon: book
|
||||||
|
topics:
|
||||||
|
- Copilot
|
||||||
|
---
|
||||||
|
|
||||||
|
When you're working on code, you often need to quickly create accurate and comprehensive explanations to share your work with teammates or the broader community. {% data variables.product.prodname_copilot_chat_short %} can help by suggesting ideas, outlines, or complete drafts for discussions or blog posts—enabling you to document and communicate clearly, so you can spend more time focused on coding.
|
||||||
|
|
||||||
|
>[!TIP] You can include links to specific pull requests or issues in your prompts to give {% data variables.product.prodname_copilot_chat_short %} more context. If you're not getting the results you expect, try specifying the repository in your prompt to help {% data variables.product.prodname_copilot_chat_short %} focus on the right project.
|
||||||
|
|
||||||
|
## Generating ideas
|
||||||
|
|
||||||
|
When you're working on a project, you may need to write a discussion or blog post to share your ideas, get feedback, or communicate with your team. {% data variables.product.prodname_copilot_chat_short %} can help you generate ideas.
|
||||||
|
|
||||||
|
### Brainstorming topics from recent work
|
||||||
|
|
||||||
|
If you're looking for ideas for a discussion post, you can ask {% data variables.product.prodname_copilot_chat_short %} to suggest topics based on your recent work.
|
||||||
|
|
||||||
|
#### Example prompts
|
||||||
|
|
||||||
|
`I’ve worked on three major PRs (#21, #27, and #44) in the last month. Could you suggest five potential blog topics that highlight the unique challenges or solutions from each PR?`
|
||||||
|
|
||||||
|
`We improved backend performance in PR #16 and addressed user feedback in Issues #10 and #12. What interesting blog ideas can you propose that tie these updates together for a developer audience?`
|
||||||
|
|
||||||
|
`We released a major version upgrade in PR #99 for our library. Could you suggest three blog angles that highlight the major changes, the lessons we learned, and how the community can benefit from it?`
|
||||||
|
|
||||||
|
`We’ve been working on a new AI-driven feature in PR #120. Please propose some blog post titles and short descriptions that will catch developers’ attention while explaining how this feature fits into our product roadmap.`
|
||||||
|
|
||||||
|
### Writing technical deep dives
|
||||||
|
|
||||||
|
When you're working on a complex feature or system, you may need to write a technical deep dive to share your work with your team or the broader community. {% data variables.product.prodname_copilot_chat_short %} can help you generate ideas for technical deep dives by suggesting topics based on your recent work.
|
||||||
|
|
||||||
|
#### Example prompts
|
||||||
|
|
||||||
|
`I just finished implementing a complex authentication flow in PR #30. Could you outline a blog post explaining the challenges we faced, the approach we took to solve them, and a brief code example highlighting key sections?`
|
||||||
|
|
||||||
|
`Generate a blog outline that discusses our shift to a more modular architecture in PR #55. I want to explain why we made the switch, how it impacts scalability, and any trade-offs we faced along the way.`
|
||||||
|
|
||||||
|
`Propose a developer-focused blog post centered on the new caching mechanism we built in PR #64. Highlight key aspects of the implementation, show code snippets, and explain the performance improvements.`
|
||||||
|
|
||||||
|
### Sharing best practices
|
||||||
|
|
||||||
|
When you're working on a project, you may need to write a discussion post to share best practices or lessons learned. {% data variables.product.prodname_copilot_chat_short %} can help you generate ideas for discussion posts.
|
||||||
|
|
||||||
|
#### Example prompt
|
||||||
|
|
||||||
|
`I just finished implementing a complex authentication flow in PR #30. Could you outline a blog post explaining the challenges we faced, the approach we took to solve them, and a brief code summary highlighting best practices?`
|
||||||
|
|
||||||
|
## Drafting content
|
||||||
|
|
||||||
|
Once you have an idea for a discussion or blog post, you can ask {% data variables.product.prodname_copilot_chat_short %} to help you draft the content. {% data variables.product.prodname_copilot_chat_short %} can provide you with a detailed outline, a rough draft, or a polished draft, depending on your needs.
|
||||||
|
|
||||||
|
### Outlining a blog post
|
||||||
|
|
||||||
|
If you're looking for help outlining a blog post, you can ask {% data variables.product.prodname_copilot_chat_short %} to suggest a detailed outline for your post.
|
||||||
|
|
||||||
|
#### Example prompt
|
||||||
|
|
||||||
|
`Please propose an outline for a blog post based on PR #16 and Issues #10 and #12. Include new features introduced, user-facing improvements, and next steps.`
|
||||||
|
|
||||||
|
### Drafting a blog post
|
||||||
|
|
||||||
|
If you're looking for help drafting a blog post, you can ask {% data variables.product.prodname_copilot_chat_short %} to suggest a rough draft for your post.
|
||||||
|
|
||||||
|
#### Example prompts
|
||||||
|
|
||||||
|
`Please write a short blog post describing how we integrated a new logging module from PR #40. Highlight how it benefits users, and suggest next steps.`
|
||||||
|
|
||||||
|
`I’d like a draft paragraph summarizing exciting new features or important changes introduced in recent commits. Please explain clearly what changed and why it's significant for users.`
|
||||||
|
|
||||||
|
`Generate a brief ‘shout-out’ paragraph that highlights the contributors who submitted PRs #33 and #37, explaining their impact and thanking them for their work.`
|
||||||
|
|
||||||
|
## Refining your draft
|
||||||
|
|
||||||
|
Once you have a draft, you can ask {% data variables.product.prodname_copilot_chat_short %} to help you refine it. {% data variables.product.prodname_copilot_chat_short %} can provide you with suggestions for improving your writing, making it more engaging, or clarifying complex concepts.
|
||||||
|
|
||||||
|
### Improving tone and style
|
||||||
|
|
||||||
|
If you're looking to improve the tone and style of your writing, you can ask {% data variables.product.prodname_copilot_chat_short %} to suggest ways to make your writing more engaging or accessible.
|
||||||
|
|
||||||
|
#### Example prompt
|
||||||
|
|
||||||
|
`Please rewrite the conclusion in a more informal, conversational style. The original conclusion was: ‘Our team successfully launched a groundbreaking update.’ Make it feel more personal and celebratory.`
|
||||||
|
|
||||||
|
### Including next steps
|
||||||
|
|
||||||
|
If you're looking to include next steps in your blog post, you can ask {% data variables.product.prodname_copilot_chat_short %} to suggest ways to make your writing more actionable.
|
||||||
|
|
||||||
|
#### Example prompt
|
||||||
|
|
||||||
|
`Draft a final section on upcoming milestones and open issues labeled ‘enhancement.’ Show what's coming next, and mention opportunities for community engagement.`
|
||||||
@@ -28,6 +28,12 @@ Community members can upvote discussions and top-level comments inside discussio
|
|||||||
|
|
||||||
For more information about participation in discussions, see [AUTOTITLE](/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion).
|
For more information about participation in discussions, see [AUTOTITLE](/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion).
|
||||||
|
|
||||||
|
{% ifversion copilot %}
|
||||||
|
|
||||||
|
> [!TIP] You can also use {% data variables.product.prodname_copilot_chat_short %} to generate ideas, outlines, or drafts for discussions, based on your pull requests and issues. See [AUTOTITLE](/copilot/copilot-chat-cookbook/documenting-code/writing-discussions-or-blog-posts).
|
||||||
|
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
To collaborate with maintainers in repository discussions, a repository administrator or project maintainer must enable {% data variables.product.prodname_discussions %} for the repository. For more information, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/enabling-or-disabling-github-discussions-for-a-repository).
|
To collaborate with maintainers in repository discussions, a repository administrator or project maintainer must enable {% data variables.product.prodname_discussions %} for the repository. For more information, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/enabling-or-disabling-github-discussions-for-a-repository).
|
||||||
|
|||||||
@@ -23,6 +23,12 @@ In addition to starting or viewing discussions and polls, you can:
|
|||||||
|
|
||||||
{% ifversion fpt or ghec %}You can block users and report disruptive content to maintain a safe and pleasant environment for yourself. For more information, see [AUTOTITLE](/communities/maintaining-your-safety-on-github).{% endif %}
|
{% ifversion fpt or ghec %}You can block users and report disruptive content to maintain a safe and pleasant environment for yourself. For more information, see [AUTOTITLE](/communities/maintaining-your-safety-on-github).{% endif %}
|
||||||
|
|
||||||
|
{% ifversion copilot %}
|
||||||
|
|
||||||
|
> [!TIP] You can also use {% data variables.product.prodname_copilot_chat_short %} to generate ideas, outlines, or drafts for discussions based on your recent pull requests and issues. See [AUTOTITLE](/copilot/copilot-chat-cookbook/documenting-code/writing-discussions-or-blog-posts).
|
||||||
|
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
{% data variables.product.prodname_discussions %} must be enabled for the repository or organization for you to participate in a discussion in the repository or organization. For more information, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/enabling-or-disabling-github-discussions-for-a-repository) and [AUTOTITLE](/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization).
|
{% data variables.product.prodname_discussions %} must be enabled for the repository or organization for you to participate in a discussion in the repository or organization. For more information, see [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/enabling-or-disabling-github-discussions-for-a-repository) and [AUTOTITLE](/organizations/managing-organization-settings/enabling-or-disabling-github-discussions-for-an-organization).
|
||||||
|
|||||||
@@ -28,6 +28,12 @@ You can create and participate in issues, pull requests, {% data variables.produ
|
|||||||
You can create and participate in issues, pull requests, and team discussions, depending on the type of conversation you'd like to have.
|
You can create and participate in issues, pull requests, and team discussions, depending on the type of conversation you'd like to have.
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
|
{% ifversion copilot %}
|
||||||
|
|
||||||
|
> [!TIP] You can also use {% data variables.product.prodname_copilot_chat_short %} to generate ideas, outlines, or drafts for discussions, based on your pull requests and issues. See [AUTOTITLE](/copilot/copilot-chat-cookbook/documenting-code/writing-discussions-or-blog-posts).
|
||||||
|
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
### {% data variables.product.prodname_github_issues %}
|
### {% data variables.product.prodname_github_issues %}
|
||||||
|
|
||||||
* Are useful for discussing specific details of a project such as bug reports, planned improvements and feedback
|
* Are useful for discussing specific details of a project such as bug reports, planned improvements and feedback
|
||||||
|
|||||||
@@ -21,6 +21,12 @@ You can create issues in your repository to plan, discuss, and track work. Issue
|
|||||||
|
|
||||||
Issues can be created in a variety of ways, so you can choose the most convenient method for your workflow. For example, you can create an issue from a repository,{% ifversion sub-issues %} while adding sub-issues,{% endif %} convert a comment in an issue or pull request, create an issue from a specific line of code, or via a URL query. You can also create an issue from your platform of choice: through the web UI, {% data variables.product.prodname_desktop %}, {% data variables.product.prodname_cli %}, GraphQL and REST APIs, or {% data variables.product.prodname_mobile %}. See [AUTOTITLE](/issues/tracking-your-work-with-issues/creating-an-issue).
|
Issues can be created in a variety of ways, so you can choose the most convenient method for your workflow. For example, you can create an issue from a repository,{% ifversion sub-issues %} while adding sub-issues,{% endif %} convert a comment in an issue or pull request, create an issue from a specific line of code, or via a URL query. You can also create an issue from your platform of choice: through the web UI, {% data variables.product.prodname_desktop %}, {% data variables.product.prodname_cli %}, GraphQL and REST APIs, or {% data variables.product.prodname_mobile %}. See [AUTOTITLE](/issues/tracking-your-work-with-issues/creating-an-issue).
|
||||||
|
|
||||||
|
{% ifversion copilot %}
|
||||||
|
|
||||||
|
> [!TIP] You can also use {% data variables.product.prodname_copilot_chat_short %} to generate ideas, outlines, or drafts for discussions or blog posts, based on your issues. See [AUTOTITLE](/copilot/copilot-chat-cookbook/documenting-code/writing-discussions-or-blog-posts).
|
||||||
|
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
{% ifversion sub-issues %}
|
{% ifversion sub-issues %}
|
||||||
|
|
||||||
## About sub-issues
|
## About sub-issues
|
||||||
|
|||||||
@@ -18,7 +18,7 @@ When you create a pull request, you’re asking your team to review your changes
|
|||||||
|
|
||||||
Clear context in your pull requests helps reviewers quickly see what you’ve changed and why it matters. This makes the review process faster and smoother, with less back-and-forth, and helps your team give better feedback and make confident decisions. For information on creating a pull request, see [AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).
|
Clear context in your pull requests helps reviewers quickly see what you’ve changed and why it matters. This makes the review process faster and smoother, with less back-and-forth, and helps your team give better feedback and make confident decisions. For information on creating a pull request, see [AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).
|
||||||
|
|
||||||
### Write small PRs
|
### Write small pull requests
|
||||||
|
|
||||||
Aim to create small, focused pull requests that fulfill a single purpose. Smaller pull requests are easier and faster to review and merge, leave less room to introduce bugs, and provide a clearer history of changes.
|
Aim to create small, focused pull requests that fulfill a single purpose. Smaller pull requests are easier and faster to review and merge, leave less room to introduce bugs, and provide a clearer history of changes.
|
||||||
|
|
||||||
@@ -61,7 +61,7 @@ You can use {% data variables.product.prodname_copilot_short %} to generate a su
|
|||||||
|
|
||||||
1. On {% data variables.product.github %}, create a pull request or navigate to an existing pull request.
|
1. On {% data variables.product.github %}, create a pull request or navigate to an existing pull request.
|
||||||
|
|
||||||
> [!NOTE] {% data variables.product.prodname_copilot %} does not take into account any existing content in the pull request description, so it is best to start with a blank description.
|
> [!NOTE] {% data variables.product.prodname_copilot_short %} does not take into account any existing content in the pull request description, so it is best to start with a blank description.
|
||||||
|
|
||||||
1. Navigate to the text field where you want to add the pull request summary.
|
1. Navigate to the text field where you want to add the pull request summary.
|
||||||
|
|
||||||
@@ -73,10 +73,12 @@ You can use {% data variables.product.prodname_copilot_short %} to generate a su
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
1. Wait for {% data variables.product.prodname_copilot %} to produce the summary, then check over the results carefully.
|
1. Wait for {% data variables.product.prodname_copilot_short %} to produce the summary, then check over the results carefully.
|
||||||
1. Add any additional context that will help people viewing your pull request.
|
1. Add any additional context that will help people viewing your pull request.
|
||||||
1. When you're happy with the description, click **Create pull request** on a new pull request, or **Update comment** if you're editing an existing description.
|
1. When you're happy with the description, click **Create pull request** on a new pull request, or **Update comment** if you're editing an existing description.
|
||||||
|
|
||||||
|
> [!TIP] You can also use {% data variables.product.prodname_copilot_chat_short %} to turn your work into a discussion or blog post. See [AUTOTITLE](/copilot/copilot-chat-cookbook/documenting-code/writing-discussions-or-blog-posts).
|
||||||
|
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
### Link to related issues or projects
|
### Link to related issues or projects
|
||||||
|
|||||||
Reference in New Issue
Block a user