diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..497bb5155 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,35 @@ +--- +name: Bug report +about: Report a reproducible software defect +title: 'bug: ' +labels: bug +assignees: '' +--- + +## Reproducer + +Provide the smallest script or snippet that reproduces the bug. + +```python + +``` + +## Traceback + +Paste the complete traceback here. + +```text + +``` + +## Versions + +Run the following command and paste its output: + +```bash +pip show autolens autogalaxy autofit autoarray autonerves +``` + +## Expected vs actual + +Describe what you expected to happen and what happened instead. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..079c9911d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,11 @@ +blank_issues_enabled: true +contact_links: + - name: Ask a question / get help + url: https://github.com/orgs/PyAutoLabs/discussions/categories/help-questions + about: Ask installation, usage, or analysis questions in the PyAutoLabs Discussions hub. + - name: Suggest an idea / propose an implementation + url: https://github.com/orgs/PyAutoLabs/discussions/categories/ideas-proposals + about: Suggest an idea or develop an implementation proposal with the community. + - name: Report an error / investigate a bug + url: https://github.com/orgs/PyAutoLabs/discussions/categories/bugs-errors + about: Discuss an error or investigate whether unexpected behavior is a bug. diff --git a/README.md b/README.md index eb5a02806..04733b3f5 100644 --- a/README.md +++ b/README.md @@ -49,6 +49,14 @@ convolver.kernel.shape_native # (11, 11) convolver.kernel.array.sum() # 1.0 ``` +## Community & Support + +Questions, help with your code or your analysis, and ideas: the +[PyAutoLabs Discussions](https://github.com/orgs/PyAutoLabs/discussions). +Bug reports with a reproducer (a snippet, the traceback, your versions): +an issue on the library's tracker. The Slack is for collaborators, by +invitation. + ## Links - Source & tests: [`autoarray/`](autoarray), [`test_autoarray/`](test_autoarray)