Files
OpenFrontIO/.github/ISSUE_TEMPLATE/new-contribution-template-examples.md
T
APuddle210 99d8351700 Fix Accidental Replacement of Issues Template (#501)
## Description:

Fix accidental replacement of original New Issues Template with the
clean version. Restores original and appents -Examples to its filename.
Appends -Clean to the filename of the clean version.

Doh! Makes no changes outside the .github folder. 

Fixes #502

## 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
2025-04-12 21:03:36 -07:00

3.0 KiB

name, about, title, labels, assignees
name about title labels assignees
New Contribution Template For new Contributions to be added to the Project Management Process

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]