Struggling to Write Effective GitHub Issue Reports
If you're searching for a Claude prompt for GitHub issues, you're likely trying to automate or streamline the process of writing clear, actionable bug reports. Perhaps you're a developer tasked with creating issue reports for your team, or a project manager looking to reduce the noise in your GitHub issue tracker. Whatever your role, you know that poorly written issue reports can lead to wasted time, miscommunication, and frustration for everyone involved. Your current approach might involve manually writing out each issue report, trying to remember all the relevant details, or using a template that doesn't quite fit your needs.
The Pattern that Works
We've found that stacking the /trim and /simplify prompt codes can be a game-changer for writing effective GitHub issue reports. /trim helps to cut through the noise and focus on the essential information, while /simplify ensures that the language used is clear and concise. By combining these two codes, you can create a prompt that generates a well-structured, easy-to-understand issue report.
Before and After Example
Let's say you're trying to report an issue with a particular feature that's not working as expected. Your initial prompt might look like this:
Write a GitHub issue report for a bug with the login feature that's causing an error when trying to authenticate with Google
Without the right prompt codes, the response might be something like:
"We're experiencing a problem with the login feature. Sometimes it works, but sometimes it doesn't. Can you please fix it?"
By adding the /trim and /simplify codes, your prompt becomes:
/trim /simplify Write a GitHub issue report for a bug with the login feature that's causing an error when trying to authenticate with Google
The response is now:
"Login feature error: when attempting to authenticate with Google, the following error message is displayed: 'Authentication failed'. Steps to reproduce: 1) Go to login page, 2) Click 'Login with Google', 3) Enter credentials. Expected result: successful login. Actual result: error message."
Anti-Patterns that Don't Work
You might be tempted to try other prompt codes that seem similar, but don't quite get the job done. For example, using /hook instead of /trim might result in a prompt that's too focused on marketing-speak, rather than the technical details of the issue. Similarly, using /deepthink might generate a response that's too verbose and theoretical, rather than practical and actionable. Another anti-pattern is using /voice without specifying the tone or audience, which can result in a response that's too casual or informal for a professional GitHub issue report.
When NOT to Use this Approach
It's worth noting that this approach is not suitable for every type of GitHub issue report. If you're dealing with a highly complex or nuanced issue that requires a lot of context and background information, you may need to use a more customized approach. Additionally, if you're trying to generate issue reports for a large number of similar issues, you may want to consider using a more automated tool or script. In these cases, using a prompt code like /mirror or /blindspots might be more effective in identifying patterns and areas for improvement.
Next Steps
If you're looking to improve your GitHub issue reporting workflow, we encourage you to experiment with different prompt codes and combinations. See all 120 codes tested over 3 months in the Cheat Sheet to find the ones that work best for your specific use case.