Skip to content

Enhance Pull Request query configuration with comprehensive examples and documentation#7660

Merged
alexr00 merged 5 commits intomainfrom
copilot/fix-7010
Aug 29, 2025
Merged

Enhance Pull Request query configuration with comprehensive examples and documentation#7660
alexr00 merged 5 commits intomainfrom
copilot/fix-7010

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Aug 26, 2025

The Pull Request query configuration UI lacked sufficient examples and documentation, making it difficult for users to understand how to create custom queries. When users clicked "Configure..." → "Configure Queries", they saw basic variable information but no practical examples of how to use GitHub search syntax in VS Code settings.

Before this change:

  • Settings UI showed variable descriptions but no concrete examples
  • "Edit in settings.json" provided minimal guidance
  • Users had to search extensively to find working query examples

After this change:

  • Added comprehensive documentation with 6 practical query examples:

    • Mentioned Me: is:open mentions:${user}
    • Recent Activity: is:open updated:>${today-7d} (demonstrates date variables)
    • My Team's PRs: is:open team:${owner}/my-team (team-based filtering)
    • High Priority: is:open label:priority-high (label filtering)
    • Ready to Merge: is:open review:approved -label:do-not-merge (advanced filtering)
  • Improved variable documentation with clear examples

  • Added properly formatted JSON code block that users can copy directly to settings.json

  • Enhanced individual property descriptions to be more helpful

Example of the new documentation:

"githubPullRequests.queries": [
  {
    "label": "Mentioned Me",
    "query": "is:open mentions:${user}"
  },
  {
    "label": "Recent Activity", 
    "query": "is:open updated:>${today-7d}"
  }
]

This provides users with immediate, actionable examples they can copy and customize for their workflows.

Fixes #7010.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI and others added 2 commits August 26, 2025 08:45
…ntation

Co-authored-by: alexr00 <38270282+alexr00@users.noreply.github.com>
… documentation

Co-authored-by: alexr00 <38270282+alexr00@users.noreply.github.com>
Copilot AI changed the title [WIP] Configuring Pull Request queries should have a sample query or documentation link Enhance Pull Request query configuration with comprehensive examples and documentation Aug 26, 2025
Copilot AI requested a review from alexr00 August 26, 2025 08:50
Copy link
Copy Markdown
Member

@alexr00 alexr00 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot revert the proposed api file changes

Co-authored-by: alexr00 <38270282+alexr00@users.noreply.github.com>
Copy link
Copy Markdown
Contributor Author

Copilot AI commented Aug 26, 2025

@copilot revert the proposed api file changes

I've reverted the proposed API file changes as requested. The changes to vscode.proposed.chatParticipantAdditions.d.ts, vscode.proposed.chatParticipantPrivate.d.ts, and vscode.proposed.languageModelDataPart.d.ts have been removed while preserving the PR query configuration enhancements in package.nls.json. (46800a8)

Copilot AI requested a review from alexr00 August 26, 2025 09:01
@alexr00 alexr00 marked this pull request as ready for review August 29, 2025 09:52
@alexr00 alexr00 enabled auto-merge (squash) August 29, 2025 09:52
@vs-code-engineering vs-code-engineering Bot added this to the August 2025 milestone Aug 29, 2025
@alexr00 alexr00 merged commit 274e0ba into main Aug 29, 2025
3 checks passed
@alexr00 alexr00 deleted the copilot/fix-7010 branch August 29, 2025 10:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Configuring Pull Request queries should have a sample query or documentation link

3 participants