Skip to content

Commit 888bdfc

Browse files
Developer-RUDeveloper-RU
committed
docs: complete repository documentation, wiki, and GitHub project hygiene
1 parent b1a7e70 commit 888bdfc

27 files changed

Lines changed: 1123 additions & 169 deletions

‎.github/CODEOWNERS‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @Developer-RU

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
name: Bug report
2+
description: Report a reproducible defect in the iOS DFU client
3+
title: "[Bug]: "
4+
labels: [bug]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for reporting a bug. Please provide enough detail to reproduce it.
10+
- type: textarea
11+
id: summary
12+
attributes:
13+
label: Summary
14+
description: What happened?
15+
placeholder: Short description of the issue
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: steps
20+
attributes:
21+
label: Steps to reproduce
22+
description: Provide exact reproduction steps
23+
placeholder: |
24+
1. Open app
25+
2. Select device
26+
3. Start DFU
27+
4. Observe error
28+
validations:
29+
required: true
30+
- type: textarea
31+
id: expected
32+
attributes:
33+
label: Expected behavior
34+
validations:
35+
required: true
36+
- type: textarea
37+
id: actual
38+
attributes:
39+
label: Actual behavior
40+
validations:
41+
required: true
42+
- type: input
43+
id: ios
44+
attributes:
45+
label: iOS version
46+
placeholder: iOS 17.5
47+
- type: input
48+
id: device
49+
attributes:
50+
label: iPhone model
51+
placeholder: iPhone 15 Pro
52+
- type: input
53+
id: firmware
54+
attributes:
55+
label: ESP32 firmware version
56+
placeholder: v1.2.3
57+
- type: textarea
58+
id: logs
59+
attributes:
60+
label: Logs and attachments
61+
description: Include relevant app logs, serial logs, screenshots, or videos

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Security vulnerability report
4+
url: https://github.com/Developer-RU/ESP32-DFU-iOS/security/advisories/new
5+
about: Please report security issues privately.

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Feature request
2+
description: Suggest an improvement for the iOS DFU client
3+
title: "[Feature]: "
4+
labels: [enhancement]
5+
body:
6+
- type: textarea
7+
id: problem
8+
attributes:
9+
label: Problem statement
10+
description: What problem are you trying to solve?
11+
validations:
12+
required: true
13+
- type: textarea
14+
id: proposal
15+
attributes:
16+
label: Proposed solution
17+
description: Describe your preferred approach
18+
validations:
19+
required: true
20+
- type: textarea
21+
id: alternatives
22+
attributes:
23+
label: Alternatives considered
24+
description: Any alternative approaches?
25+
- type: textarea
26+
id: context
27+
attributes:
28+
label: Additional context
29+
description: Firmware constraints, UX notes, links, mockups

‎.github/dependabot.yml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: github-actions
4+
directory: "/"
5+
schedule:
6+
interval: weekly

‎.github/pull_request_template.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
## Summary
2+
3+
Describe what this pull request changes.
4+
5+
## Why
6+
7+
Explain the problem or motivation.
8+
9+
## Type of Change
10+
11+
- [ ] Bug fix
12+
- [ ] New feature
13+
- [ ] Refactor
14+
- [ ] Documentation
15+
- [ ] CI/Build
16+
17+
## Validation
18+
19+
- [ ] Project generated with xcodegen generate
20+
- [ ] Simulator build passes
21+
- [ ] Real-device DFU tested (if applicable)
22+
23+
## Screenshots (UI changes)
24+
25+
Add screenshots or short video if UI was changed.
26+
27+
## Checklist
28+
29+
- [ ] I updated relevant documentation
30+
- [ ] I updated CHANGELOG.md if needed
31+
- [ ] I used focused commits and clear messages

‎.github/workflows/ci.yml‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: iOS CI
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
8+
jobs:
9+
build:
10+
runs-on: macos-latest
11+
12+
steps:
13+
- name: Checkout
14+
uses: actions/checkout@v4
15+
16+
- name: Install XcodeGen
17+
run: brew install xcodegen
18+
19+
- name: Generate Xcode project
20+
run: xcodegen generate
21+
22+
- name: Build for iOS Simulator
23+
run: |
24+
xcodebuild \
25+
-project ESP32-DFU.xcodeproj \
26+
-scheme ESP32-DFU \
27+
-sdk iphonesimulator \
28+
-destination 'platform=iOS Simulator,name=iPhone 15' \
29+
CODE_SIGNING_ALLOWED=NO \
30+
build

‎.github/workflows/docs-quality.yml‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Docs Quality
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
8+
jobs:
9+
markdown-lint:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: Checkout
13+
uses: actions/checkout@v4
14+
15+
- name: Lint Markdown
16+
uses: DavidAnson/markdownlint-cli2-action@v20
17+
with:
18+
globs: |
19+
**/*.md
20+
21+
markdown-links:
22+
runs-on: ubuntu-latest
23+
steps:
24+
- name: Checkout
25+
uses: actions/checkout@v4
26+
27+
- name: Check Markdown links
28+
uses: gaurav-nelson/github-action-markdown-link-check@v1
29+
with:
30+
use-quiet-mode: 'yes'
31+
check-modified-files-only: 'no'
32+
base-branch: 'main'

‎.markdownlint-cli2.jsonc‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"config": {
3+
"default": true,
4+
"MD013": false,
5+
"MD033": false,
6+
"MD041": false
7+
},
8+
"globs": [
9+
"**/*.md"
10+
],
11+
"ignores": [
12+
".git/**"
13+
]
14+
}

‎CHANGELOG.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Changelog
2+
3+
All notable changes to this project are documented in this file.
4+
5+
The format is based on Keep a Changelog,
6+
and this project follows Semantic Versioning for release tags.
7+
8+
## [Unreleased]
9+
10+
## [1.0.1] - 2026-05-24
11+
12+
### Added
13+
- Initial repository documentation baseline for development, testing, and operations.
14+
- Community health files for contribution, support, and security disclosure.
15+
- GitHub issue and pull request templates.
16+
- CI workflow for project generation and iOS simulator build validation.
17+
- Documentation quality workflow for markdown linting and link validation.
18+
- Wiki source pages prepared in the wiki directory.
19+
20+
### Changed
21+
- Rewrote README to match the current codebase structure and runtime behavior.
22+
- Expanded real device DFU test plan with actionable QA scenarios.
23+
24+
## [1.0.0] - 2026-05-24
25+
26+
### Added
27+
- SwiftUI iOS client for ESP32 Legacy DFU over BLE.
28+
- BLE scanning, device selection, firmware file import, DFU stage timeline.
29+
- DFU session manager with reconnect logic and localized user messages.

0 commit comments

Comments
 (0)