diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index 0bc7237e631..00000000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,20 +0,0 @@ - - -### What you were trying to do - -### What actually happened - -### How to reproduce - -* Step 1 -* Step 2 -* Step 3 - -### Log details and game version - -### Computer details diff --git a/.github/ISSUE_TEMPLATE/crash-bug-report.md b/.github/ISSUE_TEMPLATE/crash-bug-report.md new file mode 100644 index 00000000000..3797ec7d634 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/crash-bug-report.md @@ -0,0 +1,54 @@ +--- +name: 🐛 Crash/Bug Report +about: Create a crash or bug report to help us improve Terasology +title: Crash/Bug on trying to ... +labels: 'Status: Needs Investigation, Topic: Stabilization, Type: Bug' +assignees: '' + +--- + + + +### General Info + +Terasology Launcher Version: +Terasology Version: +Operating System: +Onboard / Dedicated Graphics: +Java Version: + +### What you were trying to do + +A clear and concise description of what you expected to happen. + +### What actually happened + +A clear and concise description of what didn't match your expectations, a.k.a. the crash or malfunction you faced. + +### How to reproduce + +1. Select Terasology version '...' +1. Start Terasology +1. Select gameplay '...' +1. Add modules '...' +1. Start game +1. Do '...' +1. See error + +### Log details + +Note, that the crash reporter often provides multiple tabs with different logs. +Please attach (a link to) all of them. + +### Screenshots + +If applicable, add screenshots to help explain your problem. + +### Workaround + +If applicable, describe any workaround you found to avoid the issue + +### Additional Infos / Context + +Feel free to add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/documentation-request.md b/.github/ISSUE_TEMPLATE/documentation-request.md new file mode 100644 index 00000000000..d739732e0e9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation-request.md @@ -0,0 +1,50 @@ +--- +name: 📜 Documentation Request +about: Report a need for additional documentation for Terasology +title: Request for documentation for ... +labels: 'Category: Doc, Status: Needs Discussion' +assignees: '' + +--- + + + +### Documentation Topic + +Please use any of the following prompts to provide a clear and concise description of what you need more documentation about. You can also provide a custom description. + +* I was trying to understand the concept of ... +* I want to know more about how to use module ... +* I need more information for troubleshooting issues related to ... +* I expected ... to be documented clearer / more present. + +### Documentation Type + +- type: dropdown + id: documentation-type + attributes: + label: "Documentation Type" + description: Where / How should the information you need be provided? + options: + - In-Game (Item / Notification) + - In-Game (NPC Interaction) + - In-Game (Menu / World Creation) + - Loading Screen + - In-Code (JavaDoc / Comments) + - Module Documentation + - Terasology Wiki + - Tutorial Module + - Terasology Website + - Terasology Forum + - Discord Channel Descriptions / Pins + +Please use any of the following prompts to provide a clear and concise description of any alternative documentation types you've considered. You can also provide a custom description. + +* We could use ..., but ... +* I thought about ..., but ... +* ... won't be sufficient, because ... + +### Additional notes + +Feel free to add any other context or screenshots about your feature request here. diff --git a/.github/ISSUE_TEMPLATE/improvement-request.md b/.github/ISSUE_TEMPLATE/improvement-request.md new file mode 100644 index 00000000000..1ef99ae9eea --- /dev/null +++ b/.github/ISSUE_TEMPLATE/improvement-request.md @@ -0,0 +1,39 @@ +--- +name: ✨ Improvement Request +about: Suggest an improvement for Terasology +title: Request for improving ... +labels: 'Status: Needs Discussion, Type: Improvement' +assignees: '' + +--- + + + +### Motivation + +Is your feature request related to a problem? Please use any of the following prompts to provide a clear and concise description of what the problem is. You can also provide a custom description. + +* I feel frustrated when ... +* I'm about to uninstall Terasology when ... +* I feel disappointed when ... + +### Proposal + +Please use any of the following prompts to provide a clear and concise description of what you would like to happen instead. You can also provide a custom description. + +* I wish there was ... +* It would be fun to ... +* I would play for hours if ... + +### Alternatives + +Please use any of the following prompts to provide a clear and concise description of any alternative solutions or features you've considered. You can also provide a custom description. + +* We could use ..., but ... +* I thought about ..., but ... +* ... won't be sufficient, because ... + +### Additional notes + +Feel free to add any other context or screenshots about your feature request here. diff --git a/.github/ISSUE_TEMPLATE/roadmap-draft.md b/.github/ISSUE_TEMPLATE/roadmap-draft.md new file mode 100644 index 00000000000..7a91069c4d2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/roadmap-draft.md @@ -0,0 +1,44 @@ +--- +name: 🛤️ Roadmap Draft +about: Document the roadmap for a bigger effort within Terasology +title: Roadmap for ... +labels: 'Category: Doc, Status: Needs Discussion' +assignees: '' + +--- + + + +### Motivation + +* Is there a specific problem this effort will solve? +* Is there a specific need this effort will satisfy? +* How did you get the idea for this effort? +* What will be the benefits of this effort? + +### Proposal + +* On a high level, what will the effort entail? (there's space for a fine-granular task breakdown farther down) +* Which areas of Terasology will the effort affect? +* What is the "Definition of Done" for this effort? + +### Concerns + +* Is there specific expertise that will be needed for this effort? +* Does this effort have dependencies on other efforts? +* Do you expect this effort to conflict with any other efforts? +* What are potential drawbacks of the effort? +* What are maintenance or continuous efforts that will persist beyond the completion of this effort? + + +### Task Breakdown + +* What are the individual tasks that need to be done to complete the effort? +* Can you roughly estimate how hard the individual tasks would be for a software developer with 2 years of on-the-job Java development expertise, but no in-depth expertise in special areas such as rendering or AI? +* Which tasks are inter-dependent? +* Which tasks can be done in parallel? + +### Additional notes + +Feel free to add any other context or screenshots about your roadmap draft here. diff --git a/.idea/.gitignore b/.idea/.gitignore index e0dd9a0b70d..dc25394c5c3 100644 --- a/.idea/.gitignore +++ b/.idea/.gitignore @@ -33,7 +33,6 @@ workspace.xml /uiDesigner.xml /modules.xml /modules -/inspectionProfiles /libraries-with-intellij-classes.xml /*.local.xml diff --git a/.idea/checkstyle-idea.xml b/.idea/checkstyle-idea.xml index 9d52d6a75e7..018ade33c1b 100644 --- a/.idea/checkstyle-idea.xml +++ b/.idea/checkstyle-idea.xml @@ -4,13 +4,13 @@