Skip to content

Commit 274e0ba

Browse files
Copilotalexr00
andauthored
Enhance Pull Request query configuration with comprehensive examples and documentation (#7660)
* Initial plan * Initial analysis and plan for improving PR query configuration documentation Co-authored-by: alexr00 <38270282+alexr00@users.noreply.github.com> * Enhance PR query configuration with comprehensive examples and better documentation Co-authored-by: alexr00 <38270282+alexr00@users.noreply.github.com> * Revert proposed API file changes as requested Co-authored-by: alexr00 <38270282+alexr00@users.noreply.github.com> * Rearrange description --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: alexr00 <38270282+alexr00@users.noreply.github.com>
1 parent 95cce45 commit 274e0ba

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

package.nls.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@
2525
"githubPullRequests.codingAgent.autoCommitAndPush.description": "Allow automatic git operations (commit, push) to be performed when starting a coding agent session",
2626
"githubPullRequests.codingAgent.promptForConfirmation.description": "Prompt for confirmation before initiating a coding agent session from the UI integration.",
2727
"githubPullRequests.remotes.markdownDescription": "List of remotes, by name, to fetch pull requests from.",
28-
"githubPullRequests.queries.markdownDescription": "Specifies what queries should be used in the GitHub Pull Requests tree. All queries are made against **the currently opened repos**. Each query object has a `label` that will be shown in the tree and a search `query` using [GitHub search syntax](https://help.github.com/en/articles/understanding-the-search-syntax). The following variables can be used: \n - `${user}` will resolve to the currently logged in user \n - `${owner}` will resolve to the owner of the current repository, ex. `microsoft` in `microsoft/vscode` \n - `${repository}` will resolve to the repository name, ex. `vscode` in `microsoft/vscode` \n - `${today-Nd}`, where `N` is the number of days ago, will resolve to a date, ex. `2025-01-04`. \n\n By default these queries define the categories \"Waiting For My Review\", \"Assigned To Me\" and \"Created By Me\". If you want to preserve these, make sure they are still in the array when you modify the setting.",
29-
"githubPullRequests.queries.label.description": "The label to display for the query in the Pull Requests tree",
30-
"githubPullRequests.queries.query.description": "The query used for searching pull requests.",
28+
"githubPullRequests.queries.markdownDescription": "Specifies what queries should be used in the GitHub Pull Requests tree. All queries are made against **the currently opened repos**. Each query object has a `label` that will be shown in the tree and a search `query` using [GitHub search syntax](https://help.github.com/en/articles/understanding-the-search-syntax). By default these queries define the categories \"Copilot on My Behalf\", \"Local Pull Request Branches\", \"Waiting For My Review\", \"Assigned To Me\" and \"Created By Me\". If you want to preserve these, make sure they are still in the array when you modify the setting. \n\n**Variables available:**\n - `${user}` - currently logged in user \n - `${owner}` - repository owner, ex. `microsoft` in `microsoft/vscode` \n - `${repository}` - repository name, ex. `vscode` in `microsoft/vscode` \n - `${today-Nd}` - date N days ago, ex. `${today-7d}` becomes `2025-01-04`\n\n**Example custom queries:**\n```json\n\"githubPullRequests.queries\": [\n {\n \"label\": \"Waiting For My Review\",\n \"query\": \"is:open review-requested:${user}\"\n },\n {\n \"label\": \"Mentioned Me\",\n \"query\": \"is:open mentions:${user}\"\n },\n {\n \"label\": \"Recent Activity\",\n \"query\": \"is:open updated:>${today-7d}\"\n }\n]\n```",
29+
"githubPullRequests.queries.label.description": "The label to display for the query in the Pull Requests tree.",
30+
"githubPullRequests.queries.query.description": "The GitHub search query for finding pull requests. Use GitHub search syntax with variables like ${user}, ${owner}, ${repository}. Example: 'is:open author:${user}' finds your open pull requests.",
3131
"githubPullRequests.queries.copilotOnMyBehalf": "Copilot on My Behalf",
3232
"githubPullRequests.queries.waitingForMyReview": "Waiting For My Review",
3333
"githubPullRequests.queries.assignedToMe": "Assigned To Me",

0 commit comments

Comments
 (0)