Justin Mitchell
c9188a7347
Expand scope to support multiple e-ink devices beyond X4. Add guiding principle to fill gaps in stock firmware rather than duplicate functionality. Establish current focus on memory/flash optimization and code cleanup. Temporarily freeze new themes and network connectors to consolidate codebase before multi-device expansion.
81 lines
3.4 KiB
YAML
81 lines
3.4 KiB
YAML
name: Feature Request
|
|
description: Propose a new feature, enhancement, or change to CrossPoint
|
|
title: "Short, descriptive title of the request"
|
|
labels: ["enhancement", "needs-scope-review"]
|
|
body:
|
|
- type: markdown
|
|
attributes:
|
|
value: |
|
|
Thanks for taking the time to propose a change to CrossPoint!
|
|
|
|
**Before you continue, please read [SCOPE.md](../blob/master/SCOPE.md) and [ROADMAP.md](../blob/master/ROADMAP.md).**
|
|
|
|
CrossPoint is intentionally narrow. Most rejected proposals are rejected for scope reasons that are already
|
|
documented. The checklist below exists to save both of us time.
|
|
|
|
If you are not sure whether your idea fits, open a [Discussion](../../discussions) first instead of filing
|
|
this issue.
|
|
|
|
- type: checkboxes
|
|
id: scope-check
|
|
attributes:
|
|
label: Scope Self-Check (required)
|
|
description: Please confirm each of the following. If any are unchecked, your issue will likely be closed.
|
|
options:
|
|
- label: I have read SCOPE.md and ROADMAP.md.
|
|
required: true
|
|
- label: This is **not** a new theme or theming change (themes are temporarily closed pending the move to SD-loaded themes).
|
|
required: true
|
|
- label: This is **not** a new external network connector (sync engine, cloud storage, remote file access, OPDS extensions beyond what exists, or any new "talk to a server" feature).
|
|
required: true
|
|
- label: This is **not** an interactive app (game, calculator, notepad), writing/authoring tool, RSS/news/browser feature, media playback feature, or PDF rendering.
|
|
required: true
|
|
- label: The stock firmware does **not** already handle this well.
|
|
required: true
|
|
- label: No other popular CrossPoint fork already handles this well (or, if one does, I explain below why CrossPoint still needs it).
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: problem
|
|
attributes:
|
|
label: Problem this solves
|
|
description: What user-facing problem or reading-experience gap does this address? Be concrete.
|
|
placeholder: e.g., "When reading in landscape, paragraph breaks are inconsistent because..."
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: stock-gap
|
|
attributes:
|
|
label: Why the stock firmware (and other forks) do not already solve this
|
|
description: Explain which existing solutions you checked and why they fall short. This is the core scope filter.
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: proposal
|
|
attributes:
|
|
label: Proposed change
|
|
description: A short description of what you would build or change. Focus on user impact; implementation details can come later.
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: tradeoffs
|
|
attributes:
|
|
label: Memory / flash / complexity cost
|
|
description: |
|
|
CrossPoint runs on 380KB of RAM. Roughly how much DRAM, flash, or code complexity does this add?
|
|
"Don't know" is a valid answer, but please attempt an estimate.
|
|
placeholder: e.g., "Adds ~2KB flash for the new font tables, no DRAM impact at runtime."
|
|
validations:
|
|
required: false
|
|
|
|
- type: textarea
|
|
id: additional-context
|
|
attributes:
|
|
label: Additional context
|
|
description: Anything else relevant (links, screenshots, related discussions).
|
|
validations:
|
|
required: false
|