diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 3c25718..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -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. - -**Save file** -Please add your save file here. - -**Log File** -Please add your log files here. - -**Version** -What is your version of Dungeons of Kathallion? [i.e., commit x or release version x] - -**Additional context** -Add any other context about the problem here. For example, you could say if you received an error, if you didn't say that in the problem description. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 0000000..f8eb247 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,61 @@ +name: Bug Report +description: Create a report to help us improve the game. +title: "BUG: " +labels: ["bug"] +assignees: + - OcelotWalrus +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - type: textarea + id: describe + attributes: + label: Describe The Bug + description: Please write a clear and consize description of your bug + validations: + required: true + - type: textarea + id: reproduce + attributes: + label: To Reproduce + description: Steps To Reproduce The Behavior + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected Behavior + description: A clear and concise description of what you expected to happen. + validations: + required: true + - type: input + id: save_file + attributes: + label: Save File + description: Please add your save file here. + placeholder: ex. https://your_save_file.com/download + validations: + required: false + - type: textarea + id: logs + attributes: + label: Log File + description: Please add your log files here. You can also put your bug error message + validations: + required: false + - type: input + id: version + attributes: + label: Version + description: What is your version of Bane Of Wargs? [i.e., commit x or release version x] + validations: + required: true + - type: textarea + id: additional + attributes: + label: Additional Context + description: "Add any other context about the problem here. For example, you could say if you received an error, if you didn't say that in the problem description." + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index bbcbbe7..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: '' -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 0000000..ef06710 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -0,0 +1,35 @@ +name: Feature Request +description: Suggest an idea for this project +title: "FEATURE: " +labels: ["enhancement"] +assignees: + - OcelotWalrus +body: + - type: textarea + id: related + attributes: + label: Is your feature request related to a problem? Please describe. + description: "A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]" + validations: + required: false + - type: textarea + id: solution + attributes: + label: "Describe the solution you'd like" + description: A clear and concise description of what you want to happen. + validations: + required: true + - type: textarea + id: alternatives + attributes: + label: "Describe alternatives you've considered" + description: "A clear and concise description of any alternative solutions or features you've considered." + validations: + required: true + - type: textarea + id: additional + attributes: + label: Additional context + description: Add any other context about the feature here. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/wiki-issue.md b/.github/ISSUE_TEMPLATE/wiki-issue.md deleted file mode 100644 index a5e8eb5..0000000 --- a/.github/ISSUE_TEMPLATE/wiki-issue.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -name: Wiki Issue -about: For missing or incorrect information (or just typos) in the wiki. -title: '' -labels: documentation -assignees: '' - ---- - -**Where is the issue** -i.e, "[this](where the error is wiki page) wiki page" - -**What the issue is** -i.e, "Typo: helath instead of health" - -**Expected content** -i.e, "I expected there to not be a typo" diff --git a/.github/ISSUE_TEMPLATE/wiki-issue.yaml b/.github/ISSUE_TEMPLATE/wiki-issue.yaml new file mode 100644 index 0000000..9d1da48 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/wiki-issue.yaml @@ -0,0 +1,28 @@ +name: Documentation Issue +description: For missing or incorrect information (or just typos) in the documentation. +title: "DOCUMENTATION: " +labels: ["documentation", "enhancement"] +assignees: + - OcelotWalrus +body: + - type: input + id: where + attributes: + label: Where Is The Issue + description: "i.e, '[this](where the error is wiki page) wiki page'" + validations: + required: true + - type: textarea + id: what + attributes: + label: What The Issue Is + description: "i.e, 'Typo: helath instead of health'" + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected Content + description: "i.e, 'I expected there to not be a typo'" + validations: + required: true diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..7be6a7c --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,33 @@ +(The lines in parentheses (like this one) are instructions for filling out this template. These lines can be deleted.) +(The lines in double curly brackets ({{}}) should be replaced as it describes.) +(You can open a PR to add or improve this template, if you find it lacking!) + +(Choose one heading, or add your own.) +**Content (Artwork / Missions / Jobs)** +**Balance** +**Feature** +**Bug fix** +**CI/CD/Testing** +**Documentation** + +This PR addresses the bug/feature described in issue #{{insert number}} + +## Summary +{{Describe and explain your changes. Include links to related issues.}} + +## Screenshots +{{Include before and after screenshots demonstrating your changes, if applicable.}} + +## Usage examples +{{If your changes affect how game data can be defined, provide examples demonstrating the changes here.}} + +## Testing Done +{{Describe how you tested these changes. Ensure that new issues aren't introduced.}} +{{If this is a new feature, have you added any automated tests using the unit or integration testing framework?}} + +## Save File +This save file can be used to test these changes: +{{Attach a save file that allows people to easily test your added mission content or see your new in-game art.}} + +## Performance Impact +{{If this PR changed code, describe any performance impact (positive or negative). "N/A" if no performance-critical code is changed.}} diff --git a/README.md b/README.md index 064ae32..cad7812 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,8 @@ lolo@fedora ~ $ python main.py Check Update Quit ``` +![License](https://camo.githubusercontent.com/c455b7702b790a16a74ae91c22dfea32f39249e9b80523055ae10a4310f41849/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f6465762d686431312f70797465787467616d65) +![Python Version](https://badgen.net/badge/python/3.12/blue?icon=python) [![CD](https://github.com/Dungeons-of-Kathallion/Bane-Of-Wargs/actions/workflows/cd.yaml/badge.svg)](https://github.com/Dungeons-of-Kathallion/Bane-Of-Wargs/actions/workflows/cd.yaml) [![Validate-YAML](https://github.com/Dungeons-of-Kathallion/Bane-Of-Wargs/actions/workflows/yaml_checks.yaml/badge.svg)](https://github.com/Dungeons-of-Kathallion/Bane-Of-Wargs/actions/workflows/yaml_checks.yaml) [![Spell Checks](https://github.com/Dungeons-of-Kathallion/Bane-Of-Wargs/actions/workflows/spell_checks.yaml/badge.svg)](https://github.com/Dungeons-of-Kathallion/Bane-Of-Wargs/actions/workflows/spell_checks.yaml)