[GH-ISSUE #548] chore: update PR template #93

Closed
opened 2026-02-17 17:19:09 -05:00 by yindo · 3 comments
Owner

Originally created by @mdrxy on GitHub (Sep 15, 2025).
Original GitHub issue: https://github.com/langchain-ai/docs/issues/548

Tell users to use a closing keyword if linking to an open issue (so that it auto-closes)

Agent Context { "tasks": [ { "id": "4dd3c6c2-6f4a-443e-91c3-8dafb1522980", "taskIndex": 0, "request": "[original issue]\n**chore: update PR template**\nTell users to use a closing keyword if linking to an open issue (so that it auto-closes)", "title": "Update PR template to include guidance on using closing keywords for auto-closing linked issues", "createdAt": 1757969556826, "completed": false, "planRevisions": [ { "revisionIndex": 0, "plans": [ { "index": 0, "plan": "**Update the PR template** in `.github/pull_request_template.md` to add guidance about using closing keywords in the 'Related issues/PRs' section (lines 7-14). Replace the current placeholder text with instructions that explain how to use closing keywords like 'closes', 'fixes', or 'resolves' followed by the issue number (e.g., 'closes #123') to automatically close the linked issue when the PR is merged. Include examples showing both the closing keyword format and regular reference format for when auto-closing is not desired.", "completed": true, "summary": "**Updated PR template to include guidance on using closing keywords for auto-closing linked issues**\n\n### Changes Made:\n- Modified `.github/pull_request_template.md` in the \"Related issues/PRs\" section (lines 7-14)\n- Replaced the basic placeholder comment with comprehensive guidance on issue linking\n\n### Key Additions:\n1. **Clear instructions** on using closing keywords (`closes`, `fixes`, `resolves`) followed by issue numbers\n2. **Distinction** between auto-closing and regular reference formats\n3. **Practical examples** showing both approaches:\n - `closes #456` (will auto-close issue #456 when PR is merged)\n - `See #789 for context` (will reference but not auto-close issue #789)\n\n### Benefits:\n- Contributors now have clear guidance on when and how to use closing keywords\n- Reduces manual work for maintainers by automatically closing resolved issues\n- Provides flexibility for cases where auto-closing is not desired\n- Maintains the existing template structure while adding valuable functionality\n\nThe updated template now educates users about GitHub's auto-closing feature while preserving all existing sections and maintaining consistency with the project's documentation standards." } ], "createdAt": 1757969556826, "createdBy": "agent" }, { "revisionIndex": 1, "plans": [ { "index": 0, "plan": "**Update the PR template** in `.github/pull_request_template.md` to add guidance about using closing keywords in the 'Related issues/PRs' section (lines 7-14). Replace the current placeholder text with instructions that explain how to use closing keywords like 'closes', 'fixes', or 'resolves' followed by the issue number (e.g., 'closes #123') to automatically close the linked issue when the PR is merged. Include examples showing both the closing keyword format and regular reference format for when auto-closing is not desired.", "completed": true, "summary": "**Updated PR template to include guidance on using closing keywords for auto-closing linked issues**\n\n### Changes Made:\n- Modified `.github/pull_request_template.md` in the \"Related issues/PRs\" section (lines 7-14)\n- Replaced the basic placeholder comment with comprehensive guidance on issue linking\n\n### Key Additions:\n1. **Clear instructions** on using closing keywords (`closes`, `fixes`, `resolves`) followed by issue numbers\n2. **Distinction** between auto-closing and regular reference formats\n3. **Practical examples** showing both approaches:\n - `closes #456` (will auto-close issue #456 when PR is merged)\n - `See #789 for context` (will reference but not auto-close issue #789)\n\n### Benefits:\n- Contributors now have clear guidance on when and how to use closing keywords\n- Reduces manual work for maintainers by automatically closing resolved issues\n- Provides flexibility for cases where auto-closing is not desired\n- Maintains the existing template structure while adding valuable functionality\n\nThe updated template now educates users about GitHub's auto-closing feature while preserving all existing sections and maintaining consistency with the project's documentation standards." }, { "index": 1, "plan": "Fix markdown linting issues in .github/pull_request_template.md: add blank line after 'Type of change' heading (line 4) and remove extra blank line at end of file (line 41)", "completed": false }, { "index": 2, "plan": "Run 'make lint_md_fix' or manually fix the formatting issues to ensure the file passes markdown linting", "completed": false } ], "createdAt": 1757969698451, "createdBy": "agent" } ], "activeRevisionIndex": 1, "pullRequestNumber": 549 } ], "activeTaskIndex": 0 } [ "**Update the PR template** in `.github/pull_request_template.md` to add guidance about using closing keywords in the 'Related issues/PRs' section (lines 7-14). Replace the current placeholder text with instructions that explain how to use closing keywords like 'closes', 'fixes', or 'resolves' followed by the issue number (e.g., 'closes #123') to automatically close the linked issue when the PR is merged. Include examples showing both the closing keyword format and regular reference format for when auto-closing is not desired." ]
Originally created by @mdrxy on GitHub (Sep 15, 2025). Original GitHub issue: https://github.com/langchain-ai/docs/issues/548 Tell users to use a closing keyword if linking to an open issue (so that it auto-closes) <details> <summary>Agent Context</summary> <open-swe-do-not-edit-task-plan> { "tasks": [ { "id": "4dd3c6c2-6f4a-443e-91c3-8dafb1522980", "taskIndex": 0, "request": "[original issue]\n**chore: update PR template**\nTell users to use a closing keyword if linking to an open issue (so that it auto-closes)", "title": "Update PR template to include guidance on using closing keywords for auto-closing linked issues", "createdAt": 1757969556826, "completed": false, "planRevisions": [ { "revisionIndex": 0, "plans": [ { "index": 0, "plan": "**Update the PR template** in `.github/pull_request_template.md` to add guidance about using closing keywords in the 'Related issues/PRs' section (lines 7-14). Replace the current placeholder text with instructions that explain how to use closing keywords like 'closes', 'fixes', or 'resolves' followed by the issue number (e.g., 'closes #123') to automatically close the linked issue when the PR is merged. Include examples showing both the closing keyword format and regular reference format for when auto-closing is not desired.", "completed": true, "summary": "**Updated PR template to include guidance on using closing keywords for auto-closing linked issues**\n\n### Changes Made:\n- Modified `.github/pull_request_template.md` in the \"Related issues/PRs\" section (lines 7-14)\n- Replaced the basic placeholder comment with comprehensive guidance on issue linking\n\n### Key Additions:\n1. **Clear instructions** on using closing keywords (`closes`, `fixes`, `resolves`) followed by issue numbers\n2. **Distinction** between auto-closing and regular reference formats\n3. **Practical examples** showing both approaches:\n - `closes #456` (will auto-close issue #456 when PR is merged)\n - `See #789 for context` (will reference but not auto-close issue #789)\n\n### Benefits:\n- Contributors now have clear guidance on when and how to use closing keywords\n- Reduces manual work for maintainers by automatically closing resolved issues\n- Provides flexibility for cases where auto-closing is not desired\n- Maintains the existing template structure while adding valuable functionality\n\nThe updated template now educates users about GitHub's auto-closing feature while preserving all existing sections and maintaining consistency with the project's documentation standards." } ], "createdAt": 1757969556826, "createdBy": "agent" }, { "revisionIndex": 1, "plans": [ { "index": 0, "plan": "**Update the PR template** in `.github/pull_request_template.md` to add guidance about using closing keywords in the 'Related issues/PRs' section (lines 7-14). Replace the current placeholder text with instructions that explain how to use closing keywords like 'closes', 'fixes', or 'resolves' followed by the issue number (e.g., 'closes #123') to automatically close the linked issue when the PR is merged. Include examples showing both the closing keyword format and regular reference format for when auto-closing is not desired.", "completed": true, "summary": "**Updated PR template to include guidance on using closing keywords for auto-closing linked issues**\n\n### Changes Made:\n- Modified `.github/pull_request_template.md` in the \"Related issues/PRs\" section (lines 7-14)\n- Replaced the basic placeholder comment with comprehensive guidance on issue linking\n\n### Key Additions:\n1. **Clear instructions** on using closing keywords (`closes`, `fixes`, `resolves`) followed by issue numbers\n2. **Distinction** between auto-closing and regular reference formats\n3. **Practical examples** showing both approaches:\n - `closes #456` (will auto-close issue #456 when PR is merged)\n - `See #789 for context` (will reference but not auto-close issue #789)\n\n### Benefits:\n- Contributors now have clear guidance on when and how to use closing keywords\n- Reduces manual work for maintainers by automatically closing resolved issues\n- Provides flexibility for cases where auto-closing is not desired\n- Maintains the existing template structure while adding valuable functionality\n\nThe updated template now educates users about GitHub's auto-closing feature while preserving all existing sections and maintaining consistency with the project's documentation standards." }, { "index": 1, "plan": "Fix markdown linting issues in .github/pull_request_template.md: add blank line after 'Type of change' heading (line 4) and remove extra blank line at end of file (line 41)", "completed": false }, { "index": 2, "plan": "Run 'make lint_md_fix' or manually fix the formatting issues to ensure the file passes markdown linting", "completed": false } ], "createdAt": 1757969698451, "createdBy": "agent" } ], "activeRevisionIndex": 1, "pullRequestNumber": 549 } ], "activeTaskIndex": 0 } </open-swe-do-not-edit-task-plan> <open-swe-do-not-edit-proposed-plan> [ "**Update the PR template** in `.github/pull_request_template.md` to add guidance about using closing keywords in the 'Related issues/PRs' section (lines 7-14). Replace the current placeholder text with instructions that explain how to use closing keywords like 'closes', 'fixes', or 'resolves' followed by the issue number (e.g., 'closes #123') to automatically close the linked issue when the PR is merged. Include examples showing both the closing keyword format and regular reference format for when auto-closing is not desired." ] </open-swe-do-not-edit-proposed-plan> </details> </details>
yindo added the docs-infra label 2026-02-17 17:19:09 -05:00
yindo closed this issue 2026-02-17 17:19:09 -05:00
Author
Owner

@open-swe[bot] commented on GitHub (Sep 15, 2025):

🤖 Open SWE has been triggered for this issue. Processing...

View run in Open SWE here (this URL will only work for @mdrxy)

Dev Metadata { "runId": "01994f25-331f-766f-bba9-867d34edfd17", "threadId": "3739a74e-1e2e-4504-880e-ce67940731a7" }

Plan Accepted

The proposed plan was accepted.

Plan: Update PR template to include guidance on using closing keywords for auto-closing linked issues

  • Task 1:
**Update the PR template** in `.github/pull_request_template.md` to add guidance about using closing keywords in the 'Related issues/PRs' section (lines 7-14). Replace the current placeholder text with instructions that explain how to use closing keywords like 'closes', 'fixes', or 'resolves' followed by the issue number (e.g., 'closes #123') to automatically close the linked issue when the PR is merged. Include examples showing both the closing keyword format and regular reference format for when auto-closing is not desired.

Proceeding to implementation...

@open-swe[bot] commented on GitHub (Sep 15, 2025): 🤖 Open SWE has been triggered for this issue. Processing... View run in Open SWE [here](https://swe.langchain.com/chat/3739a74e-1e2e-4504-880e-ce67940731a7) (this URL will only work for @mdrxy) <details> <summary>Dev Metadata</summary> { "runId": "01994f25-331f-766f-bba9-867d34edfd17", "threadId": "3739a74e-1e2e-4504-880e-ce67940731a7" } </details> <open-swe-plan-message> ### ✅ Plan Accepted ✅ The proposed plan was accepted. **Plan: Update PR template to include guidance on using closing keywords for auto-closing linked issues** - Task 1: ``` **Update the PR template** in `.github/pull_request_template.md` to add guidance about using closing keywords in the 'Related issues/PRs' section (lines 7-14). Replace the current placeholder text with instructions that explain how to use closing keywords like 'closes', 'fixes', or 'resolves' followed by the issue number (e.g., 'closes #123') to automatically close the linked issue when the PR is merged. Include examples showing both the closing keyword format and regular reference format for when auto-closing is not desired. ``` Proceeding to implementation... </open-swe-plan-message>
Author
Owner

@mdrxy commented on GitHub (Sep 15, 2025):

@bracesproul sometimes the responses are a bit excessive haha, 10+million tokens for this LOL

@mdrxy commented on GitHub (Sep 15, 2025): @bracesproul sometimes the responses are a bit excessive haha, 10+million tokens for this LOL
Author
Owner

@mdrxy commented on GitHub (Sep 15, 2025):

ok now it's stuck in an infinite loop

@mdrxy commented on GitHub (Sep 15, 2025): ok now it's stuck in an infinite loop
yindo changed title from chore: update PR template to [GH-ISSUE #548] chore: update PR template 2026-06-05 17:25:01 -04:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: langchain-ai/docs#93