issue

Files (1)

• SKILL.md

SKILL.md (first lines)

# GitHub Issue Creation

Create well-structured GitHub issues following repository conventions.

## Issue Title Format

Use semantic prefixes matching conventional commits:

```text
feat(scope): short description    # New feature
fix(scope): short description     # Bug fix
docs(scope): short description    # Documentation
chore(scope): short description   # Maintenance
refactor(scope): short description # Code refactoring
perf(scope): short description    # Performance improvement
```

## Issue Body Structure

### For Feature Requests

```markdown
## Summary

One paragraph describing the feature and its value.

## Problem

What problem does this solve? What's the current limitation?

## Proposed Solution

Detailed description with:

- Code examples showing desired behavior
- ASCII diagrams or mockups if applicable
- Configuration examples

## Implementation Notes

- Key files to modify
- Dependencies or prerequisites
- Potential challenges

## Benefits

- Bullet points of user/developer benefits
```

### For Bug Reports

```markdown
## Summary

One paragraph describing the bug.

## Problem

What's happening vs what should happen?
Include:

- Steps to reproduce
- Error messages or screenshots
- Environment details if relevant

## Proposed Solution

How to fix it (if known).

## References

- Links to related issues, docs, or resources
```

## Labels

Apply appropriate labels based on issue type:

| Issue Type        | Labels                    |
| ----------------- | ------------------------- |
| New feature       | `enhancement`             |
| Bug fix           | `bug`                     |
| Documentation     | `documentation`           |
| Security issue    | `bug`, `security`         |
| CI/CD related     | `ci`                      |
| New tool (lintro) | `enhancement`, `new tool` |

## AI Implementation Prompt

For issues that involve code changes, add a comment with an AI implementation prompt:

````markdown
## AI Implementation Prompt

Use this prompt in a new agent session to implement this feature:

\```
[Concise implementation instructions including:]

## Requirements

### 1. [First Component]

- What to create/modify
- Code examples

### 2. [Second Component]

- What to create/modify
- Code examples

## Files to Modify

- `/path/to/file.py` - description of changes

## Tests

- Test requirements (pytest style, NO test classes)
- Use assertpy, fixtures

From lgtm-hq/ai-skills, MIT.

More from lgtm-hq/ai-skills