diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 71e97ae..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: BUG -labels: bug -assignees: '' - ---- - -**Describe the bug** -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. - -## Visual Proof (Optional) -If possible, create a short GIF or video showing the bug in action. - -> **Helpful Tool:** You can use [LICEcap](https://www.cockos.com/licecap/) (free, available for Windows and macOS) to record your screen and capture the issue. ->**Linux Alternative:** [Peek](https://github.com/phw/peek) or [Byzanz](https://github.com/GNOME/byzanz). - -## Environment (please complete the following information): -- OS: [e.g., Windows 10, Ubuntu 20.04, macOS Montery] -- Python Version [e.g., 3.12.1] - -## Impact Level -How does this issue affect the project? (Please select one) -- [ ] Low: Minor issue with no impact on functionality. -- [ ] Medium: Causes unexpected behavior, but doesn't block core features. -- [ ] High: Blocks functionality and impacts user experience significantly. -- [ ] Critical: Game-breaking bug or security vulnerability. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..fecc72c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,111 @@ +name: Bug report +description: Create a report to help us improve PyCeas. +title: "Bug: " +labels: + - bug +assignees: [] + +body: + - type: markdown + attributes: + value: | + Please fill out the details below to help us reproduce and fix the bug. + + - type: textarea + id: bug-description + attributes: + label: bug:desc + description: A clear and concise description of what the bug is. + value: | + ### Bug description + ... + + ### Expected behavior + ... + + ### Steps to reproduce + 1. ... + 2. ... + 3. ... + + ### Additional context + Add any other context about the problem here. + validations: + required: true + + - type: dropdown + id: version + label: Version + description: If you know the version of PyCeas where the bug occurred, please select it from the list. + options: + - 0.1.0 + default: 0 + validations: + required: false + + - type: dropdown + id: type + attributes: + label: Which aspect(s) of the project is this bug related to? + description: Select all that apply. + multiple: true + options: + - label: Assets (e.g. images, sounds) + value: type:assets + - label: Audio (e.g. music, sound effects) + value: area:audio + - label: Gameplay (e.g. player movement, enemy AI) + value: area:gameplay + - label: Tools (e.g. developer tools, build scripts) + value: area:tools + - label: Visuals (e.g. sprites, animations, UI) + value: area:visuals + - label: Animations (e.g. character animations, transitions) + value: game:animations + - label: Mechanics (e.g. game rules, physics) + value: game:mechanics + - label: UI (e.g. menus, HUD) + value: game:UI + validations: + required: true + + + - type: dropdown + id: impact_level + label: impact:level + description: How does this issue affect the project? + options: + - label: Low (e.g. typo, minor error) + value: impact:low + - label: Medium (causes unexpected behavior, but doesn't break the game) + value: impact:medium + - label: High (blocks functionality or causes a crash) + value: impact:high + - label: Critical (game-breaking bug or security vulnerability.) + value: impact:critical + validations: + required: true + + - type: textarea + id: screenshots + attributes: + label: addional:screenshots + description: If applicable, add screenshots to help explain your problem. + placeholder: | + You can drag & drop or paste images directly here when submitting the form. + + - type: textarea + id: logs + attributes: + label: Relevant logs and error messages + description: Please copy and past any relevant logs or error messages here. This will be automatically formatted as code. + render: shell + + - type: textarea + id: visual_proof + attributes: + label: Visual proof + description: If possible, create a short GIF or video showing the bug in action. + + **Helpful Tool:** You can use [LICEcap](https://www.cockos.com/licecap/) (free, available for Windows and macOS) to record your screen and capture the issue. + **Linux Alternative:** [Peek](https://github.com/phw/peek) or [Byzanz](https://github.com/GNOME/byzanz) are good options for Linux users. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..db8548c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,9 @@ +blank_issues_enabled: false +contact_links: + - name: Discord server + url: https://discord.gg/MZ5MHqDnGW + about: Get help from the community! + - name: PyCeas GitHub Discussions + url: https://github.com/PyCeas/Pyceas/discussions + about: Ask questions, share ideas, and more! + diff --git a/Preview_button.png b/images/Preview_button.png similarity index 100% rename from Preview_button.png rename to images/Preview_button.png diff --git a/pull_request_template.md b/pull_request_template.md index 8efa109..88f3d52 100644 --- a/pull_request_template.md +++ b/pull_request_template.md @@ -2,7 +2,7 @@ ## 📝 Instructions Before you add a summary to your pull request, click on the `Preview` button in GitHub to see how your selected template will appear: -![Preview button](Preview_button.png) +![Preview button](images/Preview_button.png) Please choose the appropriate template based on the nature of your changes. Use one of the following templates: