From 8e723a8cf0ba421d7d5ba360278633c6148c8529 Mon Sep 17 00:00:00 2001 From: Robin Jones Date: Mon, 13 Jan 2025 01:06:28 +0000 Subject: [PATCH] Improve feature request template adds FAQ --- .github/ISSUE_TEMPLATE/feature_request.yml | 9 +++++++++ docs/00_index.md | 2 ++ docs/81_faq.md | 5 +++++ 3 files changed, 16 insertions(+) create mode 100644 docs/81_faq.md diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index c602330b..087036c5 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -22,6 +22,15 @@ body: validations: required: true + - type: textarea + id: release-context + attributes: + label: Release Context + description: Is your feature request related to the latest release or pre-release version. + placeholder: This is still not available on the latest release or the pre-release versions, so it is applicable to both (and not a regression). + validations: + required: true + - type: textarea id: solution attributes: diff --git a/docs/00_index.md b/docs/00_index.md index 0bf6460a..9b3bbe9b 100644 --- a/docs/00_index.md +++ b/docs/00_index.md @@ -26,6 +26,8 @@ - [MP3 player](./41_mp3_player.md) - [Advanced customization](./61_advanced_customization.md) - [Hardware mods](./62_hardware_mods.md) +- [FAQ](./81_faq.md) + #### Experimental Features Subject to change - [Experimental Features](./65_experimental.md) diff --git a/docs/81_faq.md b/docs/81_faq.md new file mode 100644 index 00000000..afb6d3ed --- /dev/null +++ b/docs/81_faq.md @@ -0,0 +1,5 @@ +## Frequently Asked Questions + +### ROM hack does not work +- Most ROM hacks rely on an Expansion PAK, or might be only compatible with an emulator. +- Some (very old) hacks override the CIC or save type that are not in the database. (see [here](./12_rom_configuration.md)).