diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 7f0f8b6dc..62350014e 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,10 +1,9 @@ --- name: Bug report -about: Create a report to help us reproduce and correct the bug +about: Create a report to help us reproduce and correct the bug. title: '' labels: '' assignees: '' - --- -``` +```python Sample code to reproduce the problem ``` diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md new file mode 100644 index 000000000..142efce0f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement.md @@ -0,0 +1,35 @@ +--- +name: Enhancement proposal +about: Propose an improvement to blackjax. +title: '' +labels: '' +assignees: '' +--- + + + +### Current behavior + + + +```python +Sample code with the current behavior +``` + +### Desired behavior + + + +```python +Sample code with the desired behavior +``` + + diff --git a/.github/ISSUE_TEMPLATE/how_to.md b/.github/ISSUE_TEMPLATE/how_to.md new file mode 100644 index 000000000..81efc3f38 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/how_to.md @@ -0,0 +1,9 @@ +--- +name: How to do X? +about: You would like to use blackjax but don't know how. +title: '' +labels: '' +assignees: '' +--- + +Please [open an new discussion](https://github.com/blackjax-devs/blackjax/discussions/new). The issue tracker is reserved for bug reports and feature requests. diff --git a/.github/ISSUE_TEMPLATE/sampler_proposal.md b/.github/ISSUE_TEMPLATE/sampler_proposal.md new file mode 100644 index 000000000..03249fb3a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/sampler_proposal.md @@ -0,0 +1,44 @@ +--- +name: New sampler +about: Request the implementation of a new sampler. +title: '' +labels: '' +assignees: '' +--- + + + +### Presentation of the new sampler + + + +### How does it compare to other algorithms in blackjax? + + + +### Where does it fit in blackjax + + + +### Are you willing to open a PR? + + + +