diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index bc9a65e..19ff3ed 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -13,15 +13,28 @@ body: attributes: label: App version description: Which version/tag are you using? - placeholder: "v0.2.3-alpha" + placeholder: "v0.4.32" + validations: + required: true + + - type: dropdown + id: platform + attributes: + label: Platform + description: Where does this issue happen? + options: + - macOS + - iOS + - iPadOS + - Multiple platforms validations: required: true - type: input - id: macos + id: os_version attributes: - label: macOS version - placeholder: "macOS 26.x (Tahoe)" + label: OS version + placeholder: "macOS 26.2 / iOS 18.6 / iPadOS 18.6" validations: required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 68d9d27..dc21aac 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,4 +1,4 @@ -blank_issues_enabled: true +blank_issues_enabled: false contact_links: - name: Questions / Discussions url: https://github.com/h3pdesign/Neon-Vision-Editor/discussions diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 41eb13c..4fe713d 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -8,6 +8,35 @@ body: value: | Thanks for the suggestion. Please keep requests aligned with the project's scope (lightweight native macOS editor). + - type: input + id: version + attributes: + label: Current app version + description: Which version are you currently using? + placeholder: "v0.4.32" + validations: + required: true + + - type: dropdown + id: platform + attributes: + label: Target platform + options: + - macOS + - iOS + - iPadOS + - Cross-platform + validations: + required: true + + - type: input + id: os_version + attributes: + label: OS version (if relevant) + placeholder: "macOS 26.2 / iOS 18.6 / iPadOS 18.6" + validations: + required: true + - type: textarea id: problem attributes: diff --git a/.github/ISSUE_TEMPLATE/regression_report.yml b/.github/ISSUE_TEMPLATE/regression_report.yml new file mode 100644 index 0000000..7729835 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/regression_report.yml @@ -0,0 +1,78 @@ +name: Regression report +description: Report behavior that worked before and is now broken +title: "[Regression]: " +labels: ["bug", "regression"] +body: + - type: markdown + attributes: + value: | + Thanks for reporting a regression. Please include the last known good version and first bad version if possible. + + - type: input + id: version_current + attributes: + label: Current app version (broken) + placeholder: "v0.4.32" + validations: + required: true + + - type: input + id: version_last_good + attributes: + label: Last known good version + placeholder: "v0.4.31" + validations: + required: true + + - type: dropdown + id: platform + attributes: + label: Platform + options: + - macOS + - iOS + - iPadOS + - Multiple platforms + validations: + required: true + + - type: input + id: os_version + attributes: + label: OS version + placeholder: "macOS 26.2 / iOS 18.6 / iPadOS 18.6" + validations: + required: true + + - type: textarea + id: what_changed + attributes: + label: What changed? + description: Describe what used to work and what now fails. + validations: + required: true + + - type: textarea + id: repro + attributes: + label: Repro steps + placeholder: | + 1. Open ... + 2. Click ... + 3. Observe ... + validations: + required: true + + - type: textarea + id: expected + attributes: + label: Expected behavior + validations: + required: true + + - type: textarea + id: actual + attributes: + label: Actual behavior + validations: + required: true diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..ac79f5f --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,23 @@ +## Summary + +- What changed: +- Why: + +## Validation + +- [ ] Built on macOS +- [ ] Built on iOS simulator +- [ ] Built on iPad simulator +- [ ] Tested key flow manually + +## Checklist + +- [ ] Accessibility checked (labels, focus order, no traps) +- [ ] Changelog updated (if user-facing change) +- [ ] Documentation updated (if behavior/UI changed) +- [ ] No unrelated refactors + +## Risk + +- Risk level: Low / Medium / High +- Rollback plan: diff --git a/Neon Vision Editor.xcodeproj/project.pbxproj b/Neon Vision Editor.xcodeproj/project.pbxproj index f1fd890..7275127 100644 --- a/Neon Vision Editor.xcodeproj/project.pbxproj +++ b/Neon Vision Editor.xcodeproj/project.pbxproj @@ -361,7 +361,7 @@ CODE_SIGNING_ALLOWED = YES; CODE_SIGN_IDENTITY = "Apple Development"; CODE_SIGN_STYLE = Automatic; - CURRENT_PROJECT_VERSION = 370; + CURRENT_PROJECT_VERSION = 371; DEAD_CODE_STRIPPING = YES; DEVELOPMENT_TEAM = CS727NF72U; ENABLE_APP_SANDBOX = YES; @@ -441,7 +441,7 @@ CODE_SIGNING_ALLOWED = YES; CODE_SIGN_IDENTITY = "Apple Development"; CODE_SIGN_STYLE = Automatic; - CURRENT_PROJECT_VERSION = 370; + CURRENT_PROJECT_VERSION = 371; DEAD_CODE_STRIPPING = YES; DEVELOPMENT_TEAM = CS727NF72U; ENABLE_APP_SANDBOX = YES; diff --git a/README.md b/README.md index f596735..b01f22f 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,13 @@

Neon Vision Editor

+

+ Latest Release + License: MIT + Platforms + App Store + TestFlight +

+

Neon Vision Editor Logo

@@ -35,14 +43,16 @@ ## Platform Matrix -| Capability | macOS | iOS | iPadOS | -|---|---|---|---| -| Fast text editing + syntax highlighting | ✅ | ✅ | ✅ | -| Markdown preview templates | ✅ | ❌ | ✅ | -| Project sidebar | ✅ | ✅ | ✅ | -| Quick Open (`Cmd+P`) | ✅ | ✅ (hardware keyboard) | ✅ | -| Bracket helper snippet bar | ✅ (toolbar helper) | ✅ (keyboard bar) | ✅ (keyboard bar) | -| Settings tabs + grouped cards | ✅ | ✅ | ✅ | +Availability legend: `Full` = complete support, `Partial` = available with platform constraints, `No` = currently unavailable. + +| Capability | macOS | iOS | iPadOS | Notes | +|---|---|---|---|---| +| Fast text editing + syntax highlighting | Full | Full | Full | Optimized for regular and large files. | +| Markdown preview templates | Full | No | Full | Presets: Default, Docs, Article, Compact. | +| Project sidebar | Full | Full | Full | Folder tree + nested structure rendering. | +| Quick Open (`Cmd+P`) | Full | Partial | Full | iOS requires hardware keyboard for shortcut use. | +| Bracket helper | Full | Full | Full | macOS: toolbar helper, iOS/iPadOS: keyboard snippet bar. | +| Settings tabs + grouped cards | Full | Full | Full | Localized UI with grouped preference cards. | ## Download @@ -156,9 +166,21 @@ If macOS blocks first launch: ## Visual Quick Links -- Main app screenshot: [`NeonVisionEditorApp.png`](NeonVisionEditorApp.png) -- iPad Markdown Preview and Settings visuals: [App Store screenshots](https://apps.apple.com/de/app/neon-vision-editor/id6758950965) -- Latest release assets/screenshots: [GitHub Releases](https://github.com/h3pdesign/Neon-Vision-Editor/releases) +- macOS main editor screenshot: [`docs/images/macos-main.png`](docs/images/macos-main.png) +- iPad Markdown Preview screenshot: [`docs/images/ipad-markdown-preview.png`](docs/images/ipad-markdown-preview.png) +- iPhone editor screenshot: [`docs/images/iphone-editor.png`](docs/images/iphone-editor.png) +- App Store gallery: [Neon Vision Editor on App Store](https://apps.apple.com/de/app/neon-vision-editor/id6758950965) +- Latest release assets: [GitHub Releases](https://github.com/h3pdesign/Neon-Vision-Editor/releases) + +## Roadmap (Near Term) + +- Improve iPad settings layout density and reduce scrolling friction. Tracking: [#12](https://github.com/h3pdesign/Neon-Vision-Editor/issues/12) +- Expand Markdown preview parity and interaction stability across Apple platforms. Tracking: [#13](https://github.com/h3pdesign/Neon-Vision-Editor/issues/13) +- Improve toolbar consistency and action discoverability across window sizes. Tracking: [#14](https://github.com/h3pdesign/Neon-Vision-Editor/issues/14) + +## Known Issues + +- Open known issues (live filter): [label:known-issue](https://github.com/h3pdesign/Neon-Vision-Editor/issues?q=is%3Aissue%20is%3Aopen%20label%3Aknown-issue) ## Keyboard Shortcuts @@ -243,6 +265,12 @@ git rev-parse --verify v0.4.32 shasum -a 256 ``` +## Release Policy + +- `Stable`: tagged GitHub releases intended for daily use. +- `Beta`: TestFlight builds may include in-progress UX and platform polish. +- Cadence: fixes/polish can ship between minor tags, with summary notes mirrored in README and `CHANGELOG.md`. + ## Requirements - macOS 26 (Tahoe) @@ -257,6 +285,16 @@ cd Neon-Vision-Editor open "Neon Vision Editor.xcodeproj" ``` +## Contributing Quickstart + +Contributor guide: [`CONTRIBUTING.md`](CONTRIBUTING.md) + +```bash +git clone https://github.com/h3pdesign/Neon-Vision-Editor.git +cd Neon-Vision-Editor +xcodebuild -project "Neon Vision Editor.xcodeproj" -scheme "Neon Vision Editor" -destination 'platform=macOS,name=My Mac' build +``` + ## Git hooks To auto-increment Xcode `CURRENT_PROJECT_VERSION` on every commit: diff --git a/docs/images/ipad-markdown-preview.png b/docs/images/ipad-markdown-preview.png new file mode 100644 index 0000000..789be89 Binary files /dev/null and b/docs/images/ipad-markdown-preview.png differ diff --git a/docs/images/iphone-editor.png b/docs/images/iphone-editor.png new file mode 100644 index 0000000..c6740fc Binary files /dev/null and b/docs/images/iphone-editor.png differ diff --git a/docs/images/macos-main.png b/docs/images/macos-main.png new file mode 100644 index 0000000..612f014 Binary files /dev/null and b/docs/images/macos-main.png differ