Skip to content

🧩 Git Repository Setup for Snapr Integration

After installing Snapr and connecting it to your Git repository via webhook, there's one final critical configuration step to ensure seamless AI-driven workflows: defining a standardized GitHub issue template.

🧾 Why You Need an Issue Template

Snapr leverages GitHub issues as structured prompts to trigger intelligent behaviors, including:

  • Creating pull requests automatically

  • Performing code reviews

  • Making refactoring or improvement suggestions

To provide accurate and relevant output, Snapr relies on a specific input format in issues. This helps the AI understand the intent clearly and act accordingly, just like a developer who needs to understand the task to develop.

📐 The Required Issue Template Format

Use the following format for your GitHub issues. This structure is optimized for Snapr’s AI processing:

---
name: Issue for AI development
about: This is a template to trigger AI development task properly.
title: ''
labels: aidev
assignees: ''

---

### Issue type based on the semantic commit messages convention:
- [ ] feat
- [ ] chore
- [ ] docs
- [ ] fix
- [ ] refactor
- [ ] test
- [ ] style
> More info [here](https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716)

## Proposed changes
Describe the changes you want to address with the resolution of this issue.
```
```
## Acceptance criteria 
Add the acceptance criteria that must be met when generating code that addresses this issue.

- This is an example cceptance criteria (remove it before create issue)

Snapr monitors issue creation events to identify tasks it can work on. For Snapr to recognize and act on a GitHub issue, it is essential to use the provided AI development issue template. Issues that don't follow this format will be ignored by Snapr.