Skip to content

Commit b3ed5ae

Browse files
committed
[chore] Publish audited source snapshot
Signed-off-by: Viwat Vchirawongkwin <viwat.v@chula.ac.th>
0 parents  commit b3ed5ae

592 files changed

Lines changed: 168294 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/CODEOWNERS

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# SPDX-License-Identifier: MIT
2+
* @yyods
3+
4+
/docs/specifications/protocol.md @yyods
5+
/firmware/ @yyods
6+
/.github/workflows/ @yyods

.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# SPDX-License-Identifier: MIT
2+
name: Bug report
3+
description: Report a reproducible PyBLE app, firmware, protocol, or website problem
4+
title: "[Bug] "
5+
labels:
6+
- bug
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Do not disclose security vulnerabilities here. Use the private
12+
vulnerability-reporting link in SECURITY.md.
13+
- type: dropdown
14+
id: area
15+
attributes:
16+
label: Area
17+
options:
18+
- App
19+
- Firmware
20+
- PBLE/1 protocol
21+
- Browser installer
22+
- Website
23+
- Documentation
24+
validations:
25+
required: true
26+
- type: input
27+
id: version
28+
attributes:
29+
label: Version
30+
description: App version, firmware version, or source commit
31+
validations:
32+
required: true
33+
- type: input
34+
id: hardware
35+
attributes:
36+
label: Hardware and platform
37+
description: Exact board/profile and iPadOS, Android, browser, or desktop version
38+
- type: textarea
39+
id: steps
40+
attributes:
41+
label: Reproduction steps
42+
placeholder: |
43+
1. …
44+
2. …
45+
3. …
46+
validations:
47+
required: true
48+
- type: textarea
49+
id: expected
50+
attributes:
51+
label: Expected behavior
52+
validations:
53+
required: true
54+
- type: textarea
55+
id: actual
56+
attributes:
57+
label: Actual behavior and sanitized diagnostics
58+
description: Remove device identifiers, personal files, keys, and credentials.
59+
validations:
60+
required: true
61+
- type: checkboxes
62+
id: checks
63+
attributes:
64+
label: Checks
65+
options:
66+
- label: I searched existing issues.
67+
required: true
68+
- label: This report contains no credential or private information.
69+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# SPDX-License-Identifier: MIT
2+
blank_issues_enabled: false
3+
contact_links:
4+
- name: PyBLE support
5+
url: https://pyble.dev/support
6+
about: Setup, flashing, Bluetooth, and recovery guidance
7+
- name: Security vulnerability
8+
url: https://github.com/PyBLE-dev/PyBLE/security/advisories/new
9+
about: Report security-sensitive findings privately

.github/ISSUE_TEMPLATE/feature.yml

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# SPDX-License-Identifier: MIT
2+
name: Feature or board-port proposal
3+
description: Propose a user-facing improvement or a new compatible target
4+
title: "[Proposal] "
5+
labels:
6+
- enhancement
7+
body:
8+
- type: dropdown
9+
id: area
10+
attributes:
11+
label: Area
12+
options:
13+
- App
14+
- Firmware or new board port
15+
- PBLE/1 protocol
16+
- Browser installer
17+
- Website or documentation
18+
validations:
19+
required: true
20+
- type: textarea
21+
id: problem
22+
attributes:
23+
label: Problem
24+
description: Describe the user need without prescribing an implementation.
25+
validations:
26+
required: true
27+
- type: textarea
28+
id: proposal
29+
attributes:
30+
label: Proposed outcome
31+
validations:
32+
required: true
33+
- type: textarea
34+
id: compatibility
35+
attributes:
36+
label: Compatibility and validation
37+
description: For a board port, include MicroPython, BLE peripheral, resource, and HIL details.
38+
- type: textarea
39+
id: alternatives
40+
attributes:
41+
label: Alternatives considered
42+
- type: checkboxes
43+
id: boundary
44+
attributes:
45+
label: Contribution boundary
46+
options:
47+
- label: I can contribute this as fresh, appropriately licensed work.
48+
required: true
49+
- label: I have read AGENTS.md and the relevant public specification.
50+
required: true

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<!-- SPDX-License-Identifier: MIT -->
2+
## What changed
3+
4+
<!-- Explain the user or maintainer impact and link the issue it closes. -->
5+
6+
## Specification and tests
7+
8+
<!-- Identify the public contract, red test, and validation used. -->
9+
10+
- Specification:
11+
- Tests:
12+
13+
## Checklist
14+
15+
- [ ] The change is focused and linked to an issue when appropriate.
16+
- [ ] Every commit is signed off (`git commit -s`).
17+
- [ ] A contract change updates `docs/specifications/` first.
18+
- [ ] Behavior follows red → green → refactor and has automated coverage.
19+
- [ ] The no-leak and SPDX gates pass.
20+
- [ ] New dependencies and third-party notices are recorded.
21+
- [ ] User-facing strings retain localization parity.
22+
- [ ] Upstream submodules remain pristine and pinned.
23+
- [ ] Hardware claims include reproducible HIL evidence.
24+
- [ ] Security-sensitive details are not disclosed in this pull request.

0 commit comments

Comments
 (0)