From 559d5ed27545bb94cc89b1c6944353ea198375ac Mon Sep 17 00:00:00 2001 From: LukeAndreesen <107073823+LukeAndreesen@users.noreply.github.com> Date: Tue, 12 Aug 2025 16:07:06 -0500 Subject: [PATCH] Update issue templates --- .../algorithm-implementation.md | 45 +++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/algorithm-implementation.md diff --git a/.github/ISSUE_TEMPLATE/algorithm-implementation.md b/.github/ISSUE_TEMPLATE/algorithm-implementation.md new file mode 100644 index 0000000..0787978 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/algorithm-implementation.md @@ -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.