Skip to content

Update issue templates #57

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 13, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATE/algorithm-implementation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
name: Algorithm Implementation
about: Add an additional algorithm to the qBraid Algos library
title: "[ALGORITHM]"
labels: ''
assignees: ''

---

**Required functions to implement:**
- [ ] `load_program()` - Load complete executable circuit
- [ ] `generate_subroutine()` - Generate reusable subroutine
- [ ] Additional functions: _______________

**CLI integration needed:**
- [ ] Generate command: `qbraid-algorithms generate [algorithm] [options]`
- [ ] Special options required: _______________

## Testing & Documentation

**Test cases to include:**
- [ ] Tests for each implemented Python function
- [ ] Algorithm-specific testing to clearly demonstrate successful implementation

**Documentation to provide:**
- [ ] Algorithm explanation and use cases
- [ ] Jupyter Notebook use case example

## Additional Information

**Does this algorithm have classical pre/post-processing?**
- [ ] No classical components
- [ ] Classical preprocessing only
- [ ] Classical postprocessing only
- [ ] Hybrid classical-quantum loop
- If yes, describe: _______________

**Related algorithms or dependencies:**
List any algorithms this utilizes, builds upon, or relates to

**References:**
Please list all references used for the algorithm implementation here.

**Additional context:**
Add any other context, screenshots, or examples.