From 73c0306f329dd2660e8cc2392b98a114f313545f Mon Sep 17 00:00:00 2001 From: makhlwf Date: Sat, 8 Aug 2026 20:59:29 +0200 Subject: [PATCH 1/4] Add GitHub pull request templates for code, translations, and docs --- .github/PULL_REQUEST_TEMPLATE.md | 33 +++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE/code_change.md | 32 ++++++++++++++++++ .../PULL_REQUEST_TEMPLATE/documentation.md | 12 +++++++ .github/PULL_REQUEST_TEMPLATE/translation.md | 23 +++++++++++++ 4 files changed, 100 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/code_change.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/documentation.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/translation.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..d281d79 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,33 @@ + + +## Summary & Motivation + + +## Type of Change +- [ ] 🐛 Bug fix (non-breaking change fixing an issue) +- [ ] ✨ New feature (non-breaking change adding functionality) +- [ ] ♻️ Refactoring / Maintenance +- [ ] 👷 CI / Build system / Infrastructure update +- [ ] 📝 Documentation update + +## NVDA & Accessibility Testing +- [ ] **NVDA Version(s) Tested:** +- [ ] **Speech Output:** Tested with NVDA speech synth and verified speech output accuracy. +- [ ] **Braille Output:** Tested with braille display / braille viewer (if applicable). +- [ ] **Keyboard Navigation:** Verified accessibility via keyboard shortcuts. + +## Add-on Release Checklist +- [ ] **`buildVars.py`**: Updated `minimumNVDAVersion` or `lastTestedNVDAVersion` if required. +- [ ] **Changelog**: Added user-facing change summary to `changelog.md`. +- [ ] **Localization (`i18n`)**: New translatable strings are wrapped with `_()` and `scons pot` was run. + +## Quality Assurance +- [ ] Code passes local linting & formatting checks (`ruff check`, `prek`). +- [ ] Automated tests pass (`pytest`). diff --git a/.github/PULL_REQUEST_TEMPLATE/code_change.md b/.github/PULL_REQUEST_TEMPLATE/code_change.md new file mode 100644 index 0000000..c338c7e --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/code_change.md @@ -0,0 +1,32 @@ +## Summary + + +## Related Issue + + +## Type of Change +- [ ] 🐛 Bug fix (fixes an issue without breaking existing API/behavior) +- [ ] ✨ New feature (adds new capability to the add-on) +- [ ] ⚙️ Performance improvement +- [ ] ♻️ Code refactoring (no functional changes) +- [ ] 📦 Dependency update / CI pipeline tweak + +## NVDA Testing & Verification Environment +- **Minimum NVDA Version Tested:** +- **Latest NVDA Version Tested:** +- **OS / Platform:** Windows 10 / 11 + +### Screen Reader & Accessibility Impact +- [ ] **Speech Output**: Verified speech feedback in affected NVDA modes/dialogs. +- [ ] **Braille Output**: Checked braille output/formatting. +- [ ] **Gestures & Shortcuts**: Verified keyboard shortcuts and NVDA input gestures. + +## Add-on Manifest & Metadata Verification +- [ ] **`buildVars.py`**: Verified version strings, `minimumNVDAVersion`, and `lastTestedNVDAVersion`. +- [ ] **`changelog.md`**: Added a description of the change under the unreleased/current section. +- [ ] **i18n / Translatable Strings**: Ensured all user-visible strings use gettext (`_()`), and updated `.pot` file via `scons pot` if new strings were added. + +## Local Quality Checks +- [ ] Ran `ruff check .` / `prek` cleanly. +- [ ] Ran `pytest` with 100% passing tests. +- [ ] Tested add-on bundle installation locally (`scons`). diff --git a/.github/PULL_REQUEST_TEMPLATE/documentation.md b/.github/PULL_REQUEST_TEMPLATE/documentation.md new file mode 100644 index 0000000..7e9d4a8 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/documentation.md @@ -0,0 +1,12 @@ +## Documentation Summary + + +## Scope of Changes +- [ ] 📖 User Guide / README documentation (`readme.md`, `docs/`) +- [ ] 💻 Developer documentation / code comments / docstrings +- [ ] 🌐 Localized documentation / translated doc headers + +## Verification Checklist +- [ ] Previewed rendered Markdown output for formatting and readability. +- [ ] Verified all links, image paths, and code snippets are accurate and working. +- [ ] Confirmed that HTML generation from Markdown succeeds (`scons`). diff --git a/.github/PULL_REQUEST_TEMPLATE/translation.md b/.github/PULL_REQUEST_TEMPLATE/translation.md new file mode 100644 index 0000000..dc773a5 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/translation.md @@ -0,0 +1,23 @@ +> ⚠️ **NOTICE: Translations are managed via Crowdin!** +> +> We use **Crowdin** to translate this NVDA add-on. Direct GitHub Pull Requests modifying `.po` or `.mo` files manually are generally **not accepted** to prevent translation sync conflicts. +> +> - To contribute or refine translations, please visit our **[Crowdin Project Page](https://crowdin.com)**. +> - If this PR is an automated Crowdin synchronization PR or an authorized maintainer update, please complete the fields below. + +--- + +## Translation PR Details + +### Type of Translation Contribution +- [ ] 🤖 Automated Crowdin Sync PR +- [ ] 🌐 Source `.pot` template update (`scons pot`) +- [ ] 🛠️ Maintainer emergency fix for localization files + +### Affected Languages / Locales + + +### Verification Checklist +- [ ] `scons mo` compiles all `.po` files into binary `.mo` files without gettext errors. +- [ ] Manifest localization files build cleanly (`manifest-translated.ini`). +- [ ] No manual formatting or syntax corruption introduced in `.po` headers. From 82ed58412eceab03c3c650c61c2a089eb7f07684 Mon Sep 17 00:00:00 2001 From: makhlwf Date: Mon, 10 Aug 2026 06:17:25 +0200 Subject: [PATCH 2/4] remove emojis --- .github/PULL_REQUEST_TEMPLATE.md | 10 +++++----- .github/PULL_REQUEST_TEMPLATE/code_change.md | 10 +++++----- .github/PULL_REQUEST_TEMPLATE/documentation.md | 6 +++--- .github/PULL_REQUEST_TEMPLATE/translation.md | 8 ++++---- 4 files changed, 17 insertions(+), 17 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index d281d79..ca80d59 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -11,11 +11,11 @@ Before submitting your PR, please choose the template that best matches your con ## Type of Change -- [ ] 🐛 Bug fix (non-breaking change fixing an issue) -- [ ] ✨ New feature (non-breaking change adding functionality) -- [ ] ♻️ Refactoring / Maintenance -- [ ] 👷 CI / Build system / Infrastructure update -- [ ] 📝 Documentation update +- [ ] Bug fix (non-breaking change fixing an issue) +- [ ] New feature (non-breaking change adding functionality) +- [ ] Refactoring / Maintenance +- [ ] CI / Build system / Infrastructure update +- [ ] Documentation update ## NVDA & Accessibility Testing - [ ] **NVDA Version(s) Tested:** diff --git a/.github/PULL_REQUEST_TEMPLATE/code_change.md b/.github/PULL_REQUEST_TEMPLATE/code_change.md index c338c7e..8f489b5 100644 --- a/.github/PULL_REQUEST_TEMPLATE/code_change.md +++ b/.github/PULL_REQUEST_TEMPLATE/code_change.md @@ -5,11 +5,11 @@ ## Type of Change -- [ ] 🐛 Bug fix (fixes an issue without breaking existing API/behavior) -- [ ] ✨ New feature (adds new capability to the add-on) -- [ ] ⚙️ Performance improvement -- [ ] ♻️ Code refactoring (no functional changes) -- [ ] 📦 Dependency update / CI pipeline tweak +- [ ] Bug fix (fixes an issue without breaking existing API/behavior) +- [ ] New feature (adds new capability to the add-on) +- [ ] Performance improvement +- [ ] Code refactoring (no functional changes) +- [ ] Dependency update / CI pipeline tweak ## NVDA Testing & Verification Environment - **Minimum NVDA Version Tested:** diff --git a/.github/PULL_REQUEST_TEMPLATE/documentation.md b/.github/PULL_REQUEST_TEMPLATE/documentation.md index 7e9d4a8..cadd285 100644 --- a/.github/PULL_REQUEST_TEMPLATE/documentation.md +++ b/.github/PULL_REQUEST_TEMPLATE/documentation.md @@ -2,9 +2,9 @@ ## Scope of Changes -- [ ] 📖 User Guide / README documentation (`readme.md`, `docs/`) -- [ ] 💻 Developer documentation / code comments / docstrings -- [ ] 🌐 Localized documentation / translated doc headers +- [ ] User Guide / README documentation (`readme.md`, `docs/`) +- [ ] Developer documentation / code comments / docstrings +- [ ] Localized documentation / translated doc headers ## Verification Checklist - [ ] Previewed rendered Markdown output for formatting and readability. diff --git a/.github/PULL_REQUEST_TEMPLATE/translation.md b/.github/PULL_REQUEST_TEMPLATE/translation.md index dc773a5..f941b04 100644 --- a/.github/PULL_REQUEST_TEMPLATE/translation.md +++ b/.github/PULL_REQUEST_TEMPLATE/translation.md @@ -1,4 +1,4 @@ -> ⚠️ **NOTICE: Translations are managed via Crowdin!** +> **NOTICE: Translations are managed via Crowdin!** > > We use **Crowdin** to translate this NVDA add-on. Direct GitHub Pull Requests modifying `.po` or `.mo` files manually are generally **not accepted** to prevent translation sync conflicts. > @@ -10,9 +10,9 @@ ## Translation PR Details ### Type of Translation Contribution -- [ ] 🤖 Automated Crowdin Sync PR -- [ ] 🌐 Source `.pot` template update (`scons pot`) -- [ ] 🛠️ Maintainer emergency fix for localization files +- [ ] Automated Crowdin Sync PR +- [ ] Source `.pot` template update (`scons pot`) +- [ ] Maintainer emergency fix for localization files ### Affected Languages / Locales From feb6212e36023fb88c2e6814a0063970b6497ee3 Mon Sep 17 00:00:00 2001 From: makhlwf Date: Wed, 12 Aug 2026 02:31:15 +0200 Subject: [PATCH 3/4] rework the templates, 2 templates. one for addons and another for the template it self --- .github/PULL_REQUEST_TEMPLATE.md | 33 ----------------- .../{code_change.md => ADDON_PR.md} | 7 ++++ .github/PULL_REQUEST_TEMPLATE/TEMPLATE_PR.md | 37 +++++++++++++++++++ .../PULL_REQUEST_TEMPLATE/documentation.md | 12 ------ .github/PULL_REQUEST_TEMPLATE/translation.md | 23 ------------ 5 files changed, 44 insertions(+), 68 deletions(-) delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md rename .github/PULL_REQUEST_TEMPLATE/{code_change.md => ADDON_PR.md} (89%) create mode 100644 .github/PULL_REQUEST_TEMPLATE/TEMPLATE_PR.md delete mode 100644 .github/PULL_REQUEST_TEMPLATE/documentation.md delete mode 100644 .github/PULL_REQUEST_TEMPLATE/translation.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index ca80d59..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,33 +0,0 @@ - - -## Summary & Motivation - - -## Type of Change -- [ ] Bug fix (non-breaking change fixing an issue) -- [ ] New feature (non-breaking change adding functionality) -- [ ] Refactoring / Maintenance -- [ ] CI / Build system / Infrastructure update -- [ ] Documentation update - -## NVDA & Accessibility Testing -- [ ] **NVDA Version(s) Tested:** -- [ ] **Speech Output:** Tested with NVDA speech synth and verified speech output accuracy. -- [ ] **Braille Output:** Tested with braille display / braille viewer (if applicable). -- [ ] **Keyboard Navigation:** Verified accessibility via keyboard shortcuts. - -## Add-on Release Checklist -- [ ] **`buildVars.py`**: Updated `minimumNVDAVersion` or `lastTestedNVDAVersion` if required. -- [ ] **Changelog**: Added user-facing change summary to `changelog.md`. -- [ ] **Localization (`i18n`)**: New translatable strings are wrapped with `_()` and `scons pot` was run. - -## Quality Assurance -- [ ] Code passes local linting & formatting checks (`ruff check`, `prek`). -- [ ] Automated tests pass (`pytest`). diff --git a/.github/PULL_REQUEST_TEMPLATE/code_change.md b/.github/PULL_REQUEST_TEMPLATE/ADDON_PR.md similarity index 89% rename from .github/PULL_REQUEST_TEMPLATE/code_change.md rename to .github/PULL_REQUEST_TEMPLATE/ADDON_PR.md index 8f489b5..e46378b 100644 --- a/.github/PULL_REQUEST_TEMPLATE/code_change.md +++ b/.github/PULL_REQUEST_TEMPLATE/ADDON_PR.md @@ -1,3 +1,10 @@ +--- +name: NVDA Add-on Feature / Fix PR +about: Use this template for PRs that modify add-on functionality, features, bug fixes, or translations. +title: '' +labels: '' +--- + ## Summary diff --git a/.github/PULL_REQUEST_TEMPLATE/TEMPLATE_PR.md b/.github/PULL_REQUEST_TEMPLATE/TEMPLATE_PR.md new file mode 100644 index 0000000..667673e --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/TEMPLATE_PR.md @@ -0,0 +1,37 @@ +--- +name: Add-on Template Infrastructure PR +about: Use this template for PRs that modify the AddonTemplate repository structure, build scripts, CI/CD, tooling, or documentation. +title: '[Template] ' +labels: 'template' +--- + +## Summary of Template Changes + + +## Related Issue + + +## Type of Change +- [ ] Build System / SCons updates (`sconstruct`, `site_scons/`) +- [ ] CI/CD & GitHub Actions (`.github/workflows/`, `.github/scripts/`) +- [ ] Development Dependencies & Tooling (`pyproject.toml`, `uv.lock`, `prek.toml`) +- [ ] Template Documentation & Boilerplate (`readme.md`, `docs/`, `manifest.ini.tpl`) +- [ ] Bug fix in template scripts/code +- [ ] Refactoring / Code Quality improvement + +## Downstream Add-on Impact +- [ ] **No Breaking Changes**: Existing add-ons created from this template can merge upstream changes without issue. +- [ ] **Breaking / Migration Needed**: Requires manual migration steps or configuration updates for existing add-ons (describe below). + +### Migration / Upgrade Instructions (if applicable) + + +## Local Quality Checks & Verification +- [ ] Ran `scons` and verified the add-on package builds cleanly. +- [ ] Ran `prek` / `ruff check .` with zero lint errors. +- [ ] Ran `pytest` with all tests passing. +- [ ] Verified CI workflow script behavior locally or via test workflow run. + +## Documentation & Changelog +- [ ] Updated `readme.md` or developer documentation (if applicable). +- [ ] Added description of template change to `changelog.md`. diff --git a/.github/PULL_REQUEST_TEMPLATE/documentation.md b/.github/PULL_REQUEST_TEMPLATE/documentation.md deleted file mode 100644 index cadd285..0000000 --- a/.github/PULL_REQUEST_TEMPLATE/documentation.md +++ /dev/null @@ -1,12 +0,0 @@ -## Documentation Summary - - -## Scope of Changes -- [ ] User Guide / README documentation (`readme.md`, `docs/`) -- [ ] Developer documentation / code comments / docstrings -- [ ] Localized documentation / translated doc headers - -## Verification Checklist -- [ ] Previewed rendered Markdown output for formatting and readability. -- [ ] Verified all links, image paths, and code snippets are accurate and working. -- [ ] Confirmed that HTML generation from Markdown succeeds (`scons`). diff --git a/.github/PULL_REQUEST_TEMPLATE/translation.md b/.github/PULL_REQUEST_TEMPLATE/translation.md deleted file mode 100644 index f941b04..0000000 --- a/.github/PULL_REQUEST_TEMPLATE/translation.md +++ /dev/null @@ -1,23 +0,0 @@ -> **NOTICE: Translations are managed via Crowdin!** -> -> We use **Crowdin** to translate this NVDA add-on. Direct GitHub Pull Requests modifying `.po` or `.mo` files manually are generally **not accepted** to prevent translation sync conflicts. -> -> - To contribute or refine translations, please visit our **[Crowdin Project Page](https://crowdin.com)**. -> - If this PR is an automated Crowdin synchronization PR or an authorized maintainer update, please complete the fields below. - ---- - -## Translation PR Details - -### Type of Translation Contribution -- [ ] Automated Crowdin Sync PR -- [ ] Source `.pot` template update (`scons pot`) -- [ ] Maintainer emergency fix for localization files - -### Affected Languages / Locales - - -### Verification Checklist -- [ ] `scons mo` compiles all `.po` files into binary `.mo` files without gettext errors. -- [ ] Manifest localization files build cleanly (`manifest-translated.ini`). -- [ ] No manual formatting or syntax corruption introduced in `.po` headers. From 77d70dba62be2b931bab2d8e7d17672615ce860f Mon Sep 17 00:00:00 2001 From: makhlwf Date: Wed, 12 Aug 2026 02:35:26 +0200 Subject: [PATCH 4/4] remove the checkbox for changes.md cause this is for addons and not for template changes --- .github/PULL_REQUEST_TEMPLATE/TEMPLATE_PR.md | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/TEMPLATE_PR.md b/.github/PULL_REQUEST_TEMPLATE/TEMPLATE_PR.md index 667673e..fc375b2 100644 --- a/.github/PULL_REQUEST_TEMPLATE/TEMPLATE_PR.md +++ b/.github/PULL_REQUEST_TEMPLATE/TEMPLATE_PR.md @@ -34,4 +34,3 @@ labels: 'template' ## Documentation & Changelog - [ ] Updated `readme.md` or developer documentation (if applicable). -- [ ] Added description of template change to `changelog.md`.