CodeCow/Notepad3
1
0
Fork 0
mirror of https://github.com/rizonesoft/Notepad3.git synced 2026-06-11 21:03:05 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

feat: bug-report and feature request issue templates

Browse Source
This commit is contained in:
METANEOCORTEX\Kotti 2026-05-22 11:11:36 +02:00
parent 38187a1fd1
commit 369ec2059b
4 changed files with 268 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

152
.github/ISSUE_TEMPLATE/bug_report.yml vendored Normal file
View File

@ -0,0 +1,152 @@
name: Bug / Regression Report
description: Report a reproducible bug or a regression against a previously working Notepad3 version.
title: "[Bug]: "
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to file a bug report. Please fill in every required field — incomplete reports often cannot be triaged.
Before submitting:
- Check the [FAQ](https://github.com/Rizonesoft/Notepad3/blob/master/readme/faq/FAQ.md) and the [Configuration reference](https://github.com/Rizonesoft/Notepad3/blob/master/readme/config/Configuration.md).
- Search [existing issues](https://github.com/Rizonesoft/Notepad3/issues?q=is%3Aissue) for duplicates.
- If possible, try the latest [release](https://github.com/Rizonesoft/Notepad3/releases) or [beta build](https://rizonesoft.com/downloads/notepad3/) — the bug may already be fixed.
- type: input
id: np3-version
attributes:
label: Notepad3 version
description: Open **Help → About Notepad3** and copy the version line (e.g. `Notepad3 6.26.0522.1`).
placeholder: e.g. 6.26.0522.1
validations:
required: true
- type: dropdown
id: np3-build
attributes:
label: Build / architecture
description: Shown in the About dialog and in the executable filename.
options:
- x64
- x64_AVX2
- Win32 (x86)
- ARM64
- Not sure
validations:
required: true
- type: input
id: os-version
attributes:
label: Windows version & build
description: From **Settings → System → About** or `winver`. Include the edition and build number.
placeholder: e.g. Windows 11 Pro 24H2 (build 26100.2314)
validations:
required: true
- type: input
id: regression-last-good
attributes:
label: Last known good Notepad3 version (regression only)
description: If this used to work, paste the most recent version where it still worked. Leave blank if this is not a regression.
placeholder: e.g. 6.25.1110.1 — last build before the issue appeared
validations:
required: false
- type: textarea
id: repro-steps
attributes:
label: Steps to reproduce
description: Minimal, ordered steps so a maintainer can reproduce on a clean install. If the bug depends on a specific file, attach a minimal sample.
placeholder: |
1. Open Notepad3 with a fresh INI (`Notepad3 /i`).
2. Open the attached `sample.cpp`.
3. Press Ctrl+Shift+F7 to toggle …
4. Observe …
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected behavior
validations:
required: true
- type: textarea
id: actual
attributes:
label: Actual behavior
description: Include exact error text, dialog screenshots, or a short screen recording where helpful.
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional context
description: Anything else relevant — relevant `[Settings2]` keys, language DLL in use, DPI / multi-monitor setup, dark mode on/off, third-party shell hooks, AV software, custom theme files, etc.
validations:
required: false
- type: textarea
id: version-text
attributes:
label: Version & system info (paste from About dialog)
description: |
Notepad3 can generate a full diagnostic block for you — please paste it here. It complements the fields above with Scintilla / Lexilla / PCRE2 versions, dark-mode state, DPI / scale, locale, encoding, rendering technology, and the active lexer.
**How to copy it:**
1. In Notepad3, open **Help → About Notepad3**.
2. Click the **Copy Version Text** button (bottom-right of the dialog).
3. Paste the clipboard contents into the box below — the form will render it as a code block.
Leave this empty only if you cannot launch Notepad3 (e.g. a startup-crash bug). In that case, mention that in *Additional context* above.
render: text
placeholder: |
6.26.0522.1 (a1b2c3d)
Compiled with MSVC ...
Windows 11 Pro ...
Windows Colors 'Dark-Mode' Theme is SUPPORTED and SELECTED.
Scintilla v5.5.8 ...
Lexilla v5.4.6 ...
...
validations:
required: false
- type: markdown
attributes:
value: |
---
### Optional: attach your `Notepad3.ini`
If the bug seems config-dependent (a specific setting, theme, lexer behavior, …), attaching your `Notepad3.ini` often makes the difference between "cannot reproduce" and a one-day fix.
**How to attach:**
1. **Submit this issue first.** GitHub issue forms cannot accept file uploads directly — files go in a follow-up comment.
2. Locate your INI — typically next to `Notepad3.exe`, or the path shown at the top of **Help → About Notepad3 → Copy Version Text** output. You can also press **`Ctrl+F7`** in Notepad3 to open it directly in the editor.
3. After the issue is created, open it on github.com, click into the comment box, and **drag-and-drop `Notepad3.ini`** into it. GitHub will upload it and insert a link automatically.
**Before attaching, please review these sections for anything you would rather not share publicly** — issue attachments are world-readable and indexed by search engines:
- **`[Recent Files]`** — the MRU list of recently opened files (full local paths, project names).
- **`[Recent Find]`** / **`[Recent Replace]`** — recent search and replace strings (may contain text from edited documents).
- **`Favorites=`** and **`DefaultDirectory=`** keys under **`[Settings]`** — user-specific folder paths.
It's fine to delete those sections/keys entirely before attaching — Notepad3 will recreate them on the next save. Other sections (`[Settings]`, `[Settings2]`, `[Styles]`, `[Window]`, lexer sections, …) are what actually help reproduce the bug; leave them in.
If the bug **does not** reproduce on a fresh INI (test with `Notepad3 /i`), the INI attachment is especially valuable — please mention that in *Additional context* above.
- type: checkboxes
id: confirm
attributes:
label: Confirmation
options:
- label: I searched existing issues and this is not a duplicate.
required: true
- label: I can reproduce this on a clean install (or a fresh INI via `Notepad3 /i`), not only with my customized config.
required: false
- label: "If attaching `Notepad3.ini`: I've reviewed it for sensitive entries (`[Recent Files]`, `[Recent Find]`, `[Recent Replace]`, `Favorites=`, `DefaultDirectory=`) and redacted what I don't want to share publicly."
required: false

8
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Questions & Documentation
url: https://rizonesoft.com/documents/notepad3/
about: General usage questions, installer/replacement setup, and project documentation live on the Rizonesoft website.
- name: Notepad3 Readme (config, FAQ, shortcuts, …)
url: https://github.com/Rizonesoft/Notepad3/tree/master/readme
about: User-facing reference for Configuration.md, FAQ, KeyboardShortcuts, CmdLnOptions, FilePathHandling, Encryption, and more. Many "is this a bug?" questions are answered here. Please check there before filing an issue.

70
.github/ISSUE_TEMPLATE/feature_request.yml vendored Normal file
View File

@ -0,0 +1,70 @@
name: Feature / Change Request
description: Suggest a new feature, enhancement, or behavior change for Notepad3.
title: "[Feature]: "
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
Thanks for suggesting an improvement. Please describe the **problem** the change solves before the **solution** — a clear problem statement makes it easier to evaluate alternatives.
Before submitting:
- Check whether an INI key in [Configuration.md](https://github.com/Rizonesoft/Notepad3/blob/master/readme/config/Configuration.md) or a command-line switch in [CmdLnOptions.md](https://github.com/Rizonesoft/Notepad3/blob/master/readme/cmdln/CmdLnOptions.md) already covers this.
- Search [existing issues](https://github.com/Rizonesoft/Notepad3/issues?q=is%3Aissue+label%3Aenhancement) for related requests.
- type: textarea
id: summary
attributes:
label: Summary / problem statement
description: One short paragraph — what's the problem you're trying to solve, and in what situation does it come up? Don't describe the solution here.
placeholder: |
When I open very large log files (>200 MB) over a network share, Notepad3 …
validations:
required: true
- type: textarea
id: proposed-solution
attributes:
label: Proposed solution / UX
description: How should Notepad3 behave? Describe the menu entry, INI key, dialog, shortcut, or default change you have in mind. Mockups or screenshots welcome.
validations:
required: false
- type: textarea
id: alternatives
attributes:
label: Alternatives considered
description: Workarounds you've tried, other editors that do this well, existing Notepad3 features that almost cover it but don't quite, etc.
validations:
required: false
- type: dropdown
id: scope
attributes:
label: Scope (best guess)
description: Which area of Notepad3 does this touch? Pick all that apply — this is just a triage hint, get it wrong and that's fine.
multiple: true
options:
- UI / dialogs / menus
- Editor behavior (find/replace, indent, selection, folding, …)
- Lexer / syntax highlighting / themes
- Configuration / INI keys
- Command-line / shell integration
- File I/O / encoding / paths
- MiniPath
- Build / CI / packaging
- Documentation (readme/*)
- Localization
- Other / unsure
validations:
required: false
- type: checkboxes
id: confirm
attributes:
label: Confirmation
options:
- label: I searched existing issues and this is not a duplicate.
required: true
- label: This isn't already configurable via an INI key or command-line switch.
required: false

38
readme/README.md Normal file
View File

@ -0,0 +1,38 @@
# Notepad3 Documentation
This folder collects the user-facing reference documentation for Notepad3 and its companion file browser **MiniPath**. The pages here cover end-user topics — configuration, command-line switches, shortcuts, file handling, encryption, theming, and FAQs — and are linked from the main project README and from the in-app *Help* menu.
> Looking for build instructions or contributor notes? See the project [README](../README.md) at the repository root and the [CLAUDE.md](../CLAUDE.md) developer guide. For installer / Windows-Notepad-replacement setup, see the [project website](https://rizonesoft.com/documents/notepad3/).
## Contents
### Quick references
- [KeyboardShortcuts.md](KeyboardShortcuts.md) — Complete keyboard-shortcut reference for the Notepad3 editor.
- [MenuEntriesAndCmds.md](MenuEntriesAndCmds.md) — Every command exposed by the menu tree and the context menus.
### Configuration & command line
- [config/Configuration.md](config/Configuration.md) — Full reference for the portable `Notepad3.ini` (`[Settings2]` keys, restart-required settings, etc.).
- [config/FileContentFlags.md](config/FileContentFlags.md) — Markers inside a file (mode lines, BOMs) that change how Notepad3 opens or styles it.
- [cmdln/CmdLnOptions.md](cmdln/CmdLnOptions.md) — Every command-line option, switch, and positional argument accepted by `Notepad3.exe`.
### File handling
- [paths/FilePathHandling.md](paths/FilePathHandling.md) — How Notepad3 turns text into a file: hyperlinks, dialogs, relative/UNC/long paths.
- [uchardet/EncodingDetection.md](uchardet/EncodingDetection.md) — Encoding auto-detection (uchardet + BOM/heuristic layering).
- [encryption/Encryption.md](encryption/Encryption.md) — Transparent AES-256 (Rijndael/CBC) encryption and the `np3encrypt` CLI.
### Editor features
- [focusedview/FocusedView.md](focusedview/FocusedView.md) — Folding-based filter view showing only lines that match the marked word or selection.
- [tinyexprcpp/TinyExprPP.md](tinyexprcpp/TinyExprPP.md) — The embedded TinyExpr++ math/expression evaluator and where it is wired into the UI.
- [schema/CustomSchema.md](schema/CustomSchema.md) — Schemas, lexer style sets, the style mini-language, and theme import/export.
### MiniPath
- [minipath/KeyboardShortcuts.md](minipath/KeyboardShortcuts.md) — Keyboard reference for the MiniPath file browser (launched with `Ctrl+M`).
### FAQ
- [faq/FAQ.md](faq/FAQ.md) — Frequently asked questions, including Notepad2 / Notepad2-mod migration notes.