From ef7b2d2ac4ba8c134e32c44c308352ad3391b473 Mon Sep 17 00:00:00 2001 From: mein Name Date: Fri, 28 Feb 2025 21:20:59 -0500 Subject: [PATCH] update bug template --- .github/ISSUE_TEMPLATE/bug_report.md | 32 ++++++++++------------------ docs/development.md | 5 ++++- 2 files changed, 15 insertions(+), 22 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 30bd35e3..a1fc9171 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,32 +7,22 @@ assignees: alphatownsman --- -**Describe the bug** +**Description** A clear and concise description of what the bug is. -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error -**Expected behavior** -A clear and concise description of what you expected to happen. +**Expected Behavior** +What you expected to happen. -**Screenshots** -If applicable, add screenshots to help explain your problem. -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] +**Actual Behavior / Steps to Reproduce** +What you expected happens instead. +If applicable, add an unambiguous set of steps to reproduce this bug. -**Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] -**Additional context** +**Possible Fix** +Not obligatory, but suggest a fix or reason for the bug. + + +**Additional Context / Screenshots / Server Info / Browser or App** Add any other context about the problem here. diff --git a/docs/development.md b/docs/development.md index 96813890..95d3f973 100644 --- a/docs/development.md +++ b/docs/development.md @@ -119,7 +119,10 @@ django-admin makemessages --no-wrap --no-obsolete -i .venv -i neodb-takahe --kee django-admin compilemessages -i .venv -i neodb-takahe ``` - +Preview documentation: +``` +python -m mkdocs serve +``` Development in Docker Compose -----------------------------