From 4dfdfbd4cc085fe01fcc39b58e5174dfb717562c Mon Sep 17 00:00:00 2001 From: APuddle210 Date: Fri, 11 Apr 2025 12:49:16 -0400 Subject: [PATCH] Add New Contribution Issues Template, Fix Prettier Problems with Existing Issues Templates (#451) ## Description: These changes impact GitHub Behavior only, restricted entirely to the .github folder. ## Please complete the following: - [x] I have added screenshots for all UI updates - [x] I confirm I have thoroughly tested these changes and take full responsibility for any bugs introduced - [x] I understand that submitting code with bugs that could have been caught through manual testing blocks releases and new features for all contributors ## Please put your Discord username so you can be contacted if a bug or regression is found: aPuddle --- .github/ISSUE_TEMPLATE/bug_report.md | 24 +++--- .github/ISSUE_TEMPLATE/feature_request.md | 7 +- .../new-contribution-template.md | 76 +++++++++++++++++++ 3 files changed, 92 insertions(+), 15 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/new-contribution-template.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index dd84ea782..9b77ea713 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,10 +1,9 @@ --- name: Bug report about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - +title: "" +labels: "" +assignees: "" --- **Describe the bug** @@ -12,6 +11,7 @@ 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 '....' @@ -24,15 +24,17 @@ A clear and concise description of what you expected to happen. 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] + +- OS: [e.g. iOS] +- Browser [e.g. chrome, safari] +- Version [e.g. 22] **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] + +- Device: [e.g. iPhone6] +- OS: [e.g. iOS8.1] +- Browser [e.g. stock browser, safari] +- Version [e.g. 22] **Additional context** Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index bbcbbe7d6..2bc5d5f71 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,10 +1,9 @@ --- name: Feature request about: Suggest an idea for this project -title: '' -labels: '' -assignees: '' - +title: "" +labels: "" +assignees: "" --- **Is your feature request related to a problem? Please describe.** diff --git a/.github/ISSUE_TEMPLATE/new-contribution-template.md b/.github/ISSUE_TEMPLATE/new-contribution-template.md new file mode 100644 index 000000000..731517927 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/new-contribution-template.md @@ -0,0 +1,76 @@ +--- +name: New Contribution Template +about: "For new Contributions to be added to the Project Management Process " +title: "" +labels: "" +assignees: "" +--- + +By the time the contribution is ready for final review, the main post of the Issue should be able to serve as the PR description, supplemented by the testing results/peer reviews. + +## Purpose + +Very brief statement as to what this contribution's purpose is. Examples: + +- Add new feature that allows users to create custom flags. +- Fix bug: modals not closing on game start. +- Add new Iceland map. + +--- + +## Objectives + +Please provide a short list of objectives for the contribution, the number and level of specificity of the items will depend on the scope of the contribution. Is the means by which completion can be measured and success of the changes assessed. May be the starting point for the creation of sub-issues if collaboration is needed/desired. Examples: + +**For the Custom Flags Feature** + +- Create UI for Flag Customization. +- Create customization features that provide a wide range of possibilities for users to express themselves. +- Ensure some customization features are limited to users with certain traits. +- Assess user traits related to limited customization against Discord roles. +- Create method for customized flags to be displayed correctly on all connected clients. +- Create means of restricting certain customization combinations to prevent hate symbols, or ensure it is not possible to create hate symbols with provided customizations. + +**For a Bug Fix** + +- Ensure all open modals except game start (and any other expected) modal close as expected when the game starts. +- Ensure all modals still function as expected prior to game start. + +**For New Map** + +- Add New Map, Iceland to the game for use in Singleplayer and Custom lobbies. +- Add map to lobby rotation. + +--- + +## Description + +Please provide a more detailed description of what is being changed/added, how it is being changed/added, provide any additional detail related to the objectives which would be needed or useful in assessing the contribution overall. + +Examples of what info would be expected: + +**For the Custom Flags Feature** + +- Details about where the UI would be accessed from, mockups of a concept UI if they exist. +- What kind of customizations will be available. +- What traits will be provided limited customization features? (Patreons, Devs, Owner, etc.) +- What kind of customizations will be limited. +- Any high-level technical implementation details that may be useful in assessing viability, or which will require assistance from other contributors or the project owner (communication between the clients, use or access to a backend DB, discord integration, etc.) + +**For a Bug Fix** + +- Details about the bug's behavior +- Details about the cause of the bug (once known) +- Details about the fix +- Any secondary effects of implementing the fix + +**For a New Map** + +- Size of the map +- Number of Nation Bots +- Images of the Map +- Any interesting features of the map + +--- + +[Discord Name if Different]