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 12e696f1a..38112085c 100644 --- a/README.md +++ b/README.md @@ -42,12 +42,13 @@ The [**PyAutoLens AI Assistant**](https://github.com/PyAutoLabs/autolens_assista ## Community & Support -Support for **PyAutoLens** is available via our Slack workspace, where the community shares updates, discusses -gravitational lensing analysis, and helps troubleshoot problems. +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. -Slack is invitation-only. If you'd like to join, please send an email requesting an invite. - -For installation issues, bug reports, or feature requests, please raise an issue on the [GitHub issues page](https://github.com/PyAutoLabs/PyAutoLens/issues). +The collaborator Slack workspace shares project updates and discussions about gravitational lensing analysis. ## HowToLens diff --git a/docs/installation/troubleshooting.md b/docs/installation/troubleshooting.md index 9d366db13..24b73b235 100644 --- a/docs/installation/troubleshooting.md +++ b/docs/installation/troubleshooting.md @@ -18,11 +18,13 @@ If you are trying to [install via pip](https://pyautolens.readthedocs.io/en/late still having issues, we recommend you try to [install via conda](https://pyautogalaxy.readthedocs.io/en/latest/installation/conda.html) instead, or visa versa. -## Support +## Community & Support -If you are still having issues with installation, please raise an issue on the -[autolens_workspace issues page](https://github.com/PyAutoLabs/autolens_workspace/issues) with a description of the -problem and your system setup (operating system, Python version, etc.). +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. ## Current Working Directory