langchain-ai/langchain

Improve PR templates

Closed this issue · 1 comments

mdrxy commented

Privileged issue

  • I am a LangChain maintainer, or was asked directly by a LangChain maintainer to create an issue here.

Issue Content

Make use of issue types (bug/feature/task)

Agent Context { "tasks": [ { "id": "f59d3d3e-e569-4d87-b1b1-e3ab30514aec", "taskIndex": 0, "request": "[original issue]\n**Improve PR templates**\n### Privileged issue\n\n- [x] I am a LangChain maintainer, or was asked directly by a LangChain maintainer to create an issue here.\n\n### Issue Content\n\nMake use of issue types (bug/feature/task)\n\n* Currently bug report template correctly adds bug label, but should also add bug type\n * Replace link from https://python.langchain.com/docs/introduction/ to https://docs.langchain.com/oss/python/langchain/overview \n * Remove [LangChain Github Issues](https://github.com/langchain-ai/langchain/issues?q=is%3Aissue) https://github.com/langchain-ai/langchain/issues?q=is%3Aissue, since it is where they're making the issue from\n * Remove [LangChain how-to guides](https://python.langchain.com/docs/how_to/), https://python.langchain.com/docs/how_to/ \n* Feature request template should add `feature request` label and use `feature` issue type\n* Add new task type (similar to the Privileged template) for use by maintainers (but not replace)\n* Add emoji to security vulnerabilities link (like the others) if possible\n* Add emoji to documentation link if possible\n* Add emoji to forum link if possible\n* Update text `This is a bug, not a usage question. For questions, please use the LangChain Forum (https://forum.langchain.com/).` to `This is a bug, not a usage question`\n* Add a new checklist item \"This is not related to the langchain-community package\" after the one about updating", "title": "Improve GitHub issue templates by adding issue types, updating links, creating new templates, and enhancing user experience", "createdAt": 1757640325937, "completed": true, "planRevisions": [ { "revisionIndex": 0, "plans": [ { "index": 0, "plan": "**Update bug report template** in `.github/ISSUE_TEMPLATE/bug-report.yml`: Add `bug` issue type to the template metadata, replace the documentation link from `https://python.langchain.com/docs/get_started/introduction` to `https://docs.langchain.com/oss/python/langchain/overview` (line 17), remove the redundant LangChain Github Issues link (line 16), remove the LangChain how-to guides link (line 18), update the checklist text on line 28 from `This is a bug, not a usage question. For questions, please use the LangChain Forum (https://forum.langchain.com/).` to `This is a bug, not a usage question`, and add a new checklist item `This is not related to the langchain-community package` after the existing update checklist item (around line 37).", "completed": true, "summary": "Successfully updated the bug report template (`.github/ISSUE_TEMPLATE/bug-report.yml`) with all required changes:\n\n**Key Changes Made:**\n- **Added issue type**: Added `type: bug` to template metadata for proper GitHub categorization\n- **Updated documentation link**: Replaced outdated `https://python.langchain.com/docs/get_started/introduction` with current `https://docs.langchain.com/oss/python/langchain/overview`\n- **Removed redundant links**: Eliminated the redundant \"LangChain Github Issues\" link and \"LangChain how-to guides\" link to streamline the reference section\n- **Simplified checklist text**: Updated the bug checklist item from `This is a bug, not a usage question. For questions, please use the LangChain Forum (https://forum.langchain.com/).` to the cleaner `This is a bug, not a usage question`\n- **Added community package checklist**: Inserted new required checklist item `This is not related to the langchain-community package` after the update checklist item\n\n**Technical Details:**\n- All changes maintain the existing YAML structure and formatting\n- The template retains its user-friendly design while improving clarity\n- Links section is now more focused and relevant\n- Checklist items are properly ordered and maintain required validation\n\nThe updated template now provides better issue categorization through GitHub's issue types system while offering a cleaner, more focused user experience for bug reporting." }, { "index": 1, "plan": "**Create feature request template** as `.github/ISSUE_TEMPLATE/feature-request.yml`: Create a new GitHub issue template for feature requests with `feature request` label and `feature` issue type, following the structure and style of the existing bug report template but adapted for feature requests with appropriate sections for feature description, use case, and alternatives considered.", "completed": true, "summary": "Successfully created a new feature request template (`.github/ISSUE_TEMPLATE/feature-request.yml`) with all required specifications:\n\n**Key Features Implemented:**\n- **Template metadata**: Added `feature request` label and `feature` issue type as required\n- **Consistent structure**: Followed the structure and style of the existing bug report template while adapting it specifically for feature requests\n- **Appropriate sections**: Included all necessary sections for comprehensive feature requests:\n - Feature Description (required)\n - Use Case (required) \n - Proposed Solution (optional)\n - Alternatives Considered (optional)\n - Additional Context (optional)\n\n**Template Design:**\n- **User-friendly interface**: Uses ✨ emoji in the title for visual appeal\n- **Clear guidance**: Provides helpful descriptions and placeholders for each section\n- **Proper validation**: Includes required checkboxes to ensure quality submissions\n- **Consistent links**: Uses the same updated documentation links as the bug report template\n- **Community package awareness**: Includes checklist item about langchain-community package\n\n**Technical Details:**\n- Follows GitHub issue template YAML format specifications\n- Maintains consistent styling with existing templates\n- Includes proper field validation and requirements\n- Provides comprehensive guidance for users submitting feature requests\n\nThe template now enables users to submit well-structured feature requests with clear descriptions, use cases, and context, improving the quality of feature request submissions and making it easier for maintainers to evaluate and prioritize new features." }, { "index": 2, "plan": "**Create task template** as `.github/ISSUE_TEMPLATE/task.yml`: Create a new GitHub issue template for maintainer tasks with `task` issue type, using a similar structure to the existing privileged template but specifically designed for task tracking and project management by maintainers.", "completed": true, "summary": "Successfully created a new task template (`.github/ISSUE_TEMPLATE/task.yml`) with all required specifications:\n\n**Key Features Implemented:**\n- **Template metadata**: Added `task` issue type and `task` label as required\n- **Maintainer-focused design**: Similar structure to the existing privileged template but specifically designed for task tracking and project management\n- **Comprehensive task management**: Includes all necessary sections for effective task tracking:\n - Task Type dropdown (Project Management, Documentation, Refactoring, etc.)\n - Priority dropdown (Low, Medium, High, Critical)\n - Task Description (required)\n - Acceptance Criteria (required)\n - Context and Background (optional)\n - Implementation Notes (optional)\n - Dependencies (optional)\n\n**Template Design:**\n- **User-friendly interface**: Uses 📋 emoji in the title for visual appeal\n- **Maintainer verification**: Includes required checkbox to confirm maintainer status\n- **Structured approach**: Provides clear sections for task planning and tracking\n- **Flexible priority system**: Allows maintainers to categorize task urgency\n- **Comprehensive documentation**: Includes fields for context, implementation details, and dependencies\n\n**Technical Details:**\n- Follows GitHub issue template YAML format specifications\n- Maintains consistent styling with existing templates\n- Includes proper field validation and requirements\n- Provides structured dropdowns for task categorization\n- Supports project management workflows with acceptance criteria and dependency tracking\n\nThe template now enables maintainers to create well-structured tasks for project management, development planning, refactoring, documentation updates, and other organizational work, improving the efficiency of LangChain development workflows." }, { "index": 3, "plan": "**Update config file** in `.github/ISSUE_TEMPLATE/config.yml`: Add appropriate emojis to the existing Documentation and LangChain Forum contact links, and add a new security vulnerabilities contact link with emoji pointing to the security reporting mechanisms (huntr.dev and security@langchain.dev) as described in the SECURITY.md file.", "completed": true, "summary": "Successfully updated the config file (`.github/ISSUE_TEMPLATE/config.yml`) with all required enhancements:\n\n**Key Changes Made:**\n- **Added emojis to existing links**: Enhanced the Documentation link with 📚 emoji and the LangChain Forum link with 💬 emoji for better visual appeal and user experience\n- **Added security vulnerabilities contact link**: Created a new contact link with 🔒 emoji pointing to the huntr.com security reporting mechanism as described in the SECURITY.md file\n- **Comprehensive security reporting**: The new security link includes both the huntr.com URL for vulnerability disclosure and mentions the security@langchain.dev contact email in the description\n\n**Technical Details:**\n- **Documentation link**: Now displays as \"📚 Documentation\" with the same functionality\n- **Forum link**: Now displays as \"💬 LangChain Forum\" with the same functionality \n- **Security link**: New \"🔒 Security Vulnerabilities\" link that directs users to `https://huntr.com/bounties/disclose/?target=https%3A%2F%2Fgithub.com%2Flangchain-ai%2Flangchain&validSearch=true`\n- **Clear descriptions**: Each link maintains clear, helpful descriptions for users\n\n**User Experience Improvements:**\n- Visual consistency with emojis across all contact links\n- Easy identification of different support channels\n- Proper security vulnerability reporting pathway\n- Maintains all existing functionality while enhancing visual appeal\n\nThe updated config file now provides a more user-friendly interface for GitHub issue template selection, with clear visual indicators and comprehensive support options including proper security vulnerability reporting channels." } ], "createdAt": 1757640325937, "createdBy": "agent" } ], "activeRevisionIndex": 0, "pullRequestNumber": 32910, "completedAt": 1757640882870, "summary": "I have successfully improved the GitHub issue templates by adding issue types, updating links, creating new templates, and enhancing user experience. The changes include updating the bug report template, creating feature request and task templates, and updating the config file with emojis and a security vulnerabilities link. All tasks have been completed with attention to detail and maintaining the existing template structure." } ], "activeTaskIndex": 0 }
open-swe commented

🤖 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": "01993b83-f494-70fa-9be9-bead90633ae6", "threadId": "bc3acc81-dc9d-4763-a078-f3a5b37f2242" }

🤖 Plan Generated

I've generated a plan for this issue and will proceed to implement it since auto-accept is enabled.

Plan: Improve GitHub issue templates by adding issue types, updating links, creating new templates, and enhancing user experience

  • Task 1:
**Update bug report template** in `.github/ISSUE_TEMPLATE/bug-report.yml`: Add `bug` issue type to the template metadata, replace the documentation link from `https://python.langchain.com/docs/get_started/introduction` to `https://docs.langchain.com/oss/python/langchain/overview` (line 17), remove the redundant LangChain Github Issues link (line 16), remove the LangChain how-to guides link (line 18), update the checklist text on line 28 from `This is a bug, not a usage question. For questions, please use the LangChain Forum (https://forum.langchain.com/).` to `This is a bug, not a usage question`, and add a new checklist item `This is not related to the langchain-community package` after the existing update checklist item (around line 37).
  • Task 2:
**Create feature request template** as `.github/ISSUE_TEMPLATE/feature-request.yml`: Create a new GitHub issue template for feature requests with `feature request` label and `feature` issue type, following the structure and style of the existing bug report template but adapted for feature requests with appropriate sections for feature description, use case, and alternatives considered.
  • Task 3:
**Create task template** as `.github/ISSUE_TEMPLATE/task.yml`: Create a new GitHub issue template for maintainer tasks with `task` issue type, using a similar structure to the existing privileged template but specifically designed for task tracking and project management by maintainers.
  • Task 4:
**Update config file** in `.github/ISSUE_TEMPLATE/config.yml`: Add appropriate emojis to the existing Documentation and LangChain Forum contact links, and add a new security vulnerabilities contact link with emoji pointing to the security reporting mechanisms (huntr.dev and security@langchain.dev) as described in the SECURITY.md file.

Proceeding to implementation...