mirror of
https://github.com/steipete/agent-rules.git
synced 2025-12-16 12:00:09 +01:00
6c9a43512a
Major changes: - Moved github-issue-creation.mdc to global-rules/ (better suited as global rule) - Added terminal-title-wrapper.zsh for dynamic terminal titles - Added mcp-peekaboo-setup.mdc for vision-enabled MCP server - Updated README with comprehensive documentation for all rules Global rules enhance Claude Code across all projects: - GitHub issue creation from feature descriptions - Terminal title management for multi-instance organization - Peekaboo MCP setup for screenshot/vision capabilities Based on strategies from "Commanding Your Claude Code Army" 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
47 lines
2.9 KiB
Plaintext
47 lines
2.9 KiB
Plaintext
---
|
|
description: Instructions for creating well-structured GitHub issues following best practices and project conventions
|
|
globs: ""
|
|
alwaysApply: false
|
|
---
|
|
|
|
# GitHub Issue Creation
|
|
|
|
Credit: This rule is based on instructions by @nityeshaga (https://x.com/nityeshaga/status/1933113428379574367)
|
|
|
|
You are an AI assistant tasked with creating well-structured GitHub issues for feature requests, bug reports, or improvement ideas. Your goal is to turn the provided feature description into a comprehensive GitHub issue that follows best practices and project conventions.
|
|
|
|
First, you will be given a feature description and a repository URL. Here they are:
|
|
|
|
<feature_description> #$ARGUMENTS </feature_description>
|
|
|
|
Follow these steps to complete the task, make a todo list and think ultrahard:
|
|
|
|
### 1. Research the repository:
|
|
- Visit the provided repo url and examine the repository's structure, existing issues, and documentation.
|
|
- Look for any CONTRIBUTING.md, ISSUE_TEMPLATE.md, or similar files that contain guidelines for creating issues.
|
|
- Note the project's coding style, naming conventions, and any specific requirements for submitting issues.
|
|
|
|
### 2. Research best practices:
|
|
- Search for current best practices in writing GitHub issues, focusing on clarity, completeness, and actionability.
|
|
- Look for examples of well-written issues in popular open-source projects for inspiration.
|
|
|
|
### 3. Present a plan:
|
|
- Based on your research, outline a plan for creating the GitHub issue.
|
|
- Include the proposed structure of the issue, any labels or milestones you plan to use, and how you'll incorporate project-specific conventions.
|
|
- Present this plan in <plan> tags.
|
|
- Include the reference link to featurebase or any other link that has the source of the user request
|
|
*K for Command, *L for Cascade
|
|
|
|
### 4. Create the GitHub issue:
|
|
- Once the plan is approved, draft the GitHub issue content.
|
|
- Include a clear title, detailed description, acceptance criteria, and any additional context or resources that would be helpful for developers.
|
|
- Use appropriate formatting (e.g., Markdown) to enhance readability.
|
|
- Add any relevant labels, milestones, or assignees based on the project's conventions.
|
|
|
|
### 5. Final output:
|
|
- Present the complete GitHub issue content in <github_issue> tags.
|
|
- Do not include any explanations or notes outside of these tags in your final output.
|
|
|
|
Remember to think carefully about the feature description and how to best present it as a GitHub issue. Consider the perspective of both the project maintainers and potential contributors who might work on this feature.
|
|
|
|
Your final output should consist of only the content within the <github_issue> tags, ready to be copied and pasted directly into GitHub. Make sure to use the GitHub CLI `gh issue create` to create the actual issue after you generate. Assign either the label `bug` or `enhancement` based on the nature of the issue. |