You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Our goal is to make Flipper One a truly high-quality product, every feature of the device must be thoroughly tested. This section describes the testing procedures for each subsystem.
9
+
This page explains the structure of the Testing sub-project, provides links to public testing resources, and describes how to contribute to the sub-project.
10
10
11
-
## Hardware verification
11
+
The Testing sub-project covers checks for RK3576-based boards used in Flipper One development. Its goal is to turn each device feature into a repeatable test with a clear result. Testing currently prioritizes hardware verification, but test notes and assets can also cover user-interface or sound checks when those areas need repeatable pass/fail criteria.
12
12
13
-
At this stage, we need to verify that each hardware component of Flipper One performs its intended functions. The purpose is to confirm that the selected components meet our design requirements.
14
-
Each test should produce a clear **YES/NO** result, allowing us to decide whether a given component is suitable for production.
- 📚 [Manual test descriptions](./#manual-test-descriptions)
17
+
- 📁 [Automated test scripts](https://github.com/flipperdevices/flipperone-testing)
17
18
18
-
TODO: Describe publicly available test setup
19
+
***
20
+
21
+
## ✅ Task tracker
22
+
23
+
The public [Testing project board](https://github.com/orgs/flipperdevices/projects/14) tracks open work for the Testing sub-project. There, you can see what the team is working on, follow progress, and find tasks that need community help.
24
+
25
+
**Some tasks are open** to the community and marked with a **help wanted** label. You’re welcome to join the discussion on these tasks or submit test results when a task asks for them.
26
+
27
+
***
28
+
29
+
## 📚 Manual test descriptions
30
+
31
+
The Testing docs explain what should be checked for each subsystem. These pages are meant to complement the scripts: the docs describe the test goal, setup, expected result, and known gaps, while the repository contains runnable scripts or assets when they are available.
32
+
33
+
Docs in this section follow the same order as the navigation:
34
+
35
+
-[General](General.md) - boot targets, test images, and common setup notes.
-[Video Decoding](Video-decoding.md) - video-decoding checks under graphics testing.
39
+
-[Network](Network.md) - Wi-Fi and Bluetooth test scenarios.
40
+
-[Expansion modules (M.2)](M_2.md) - M.2 expansion-module test notes.
41
+
-[Cellular Modems](Cellular-Modems.md) - cellular modem tests for M.2 modules.
42
+
43
+
### Hardware verification
44
+
45
+
At this stage, testing is mainly used to verify whether each hardware component performs its intended function. A good test should answer a narrow question, for example:
46
+
47
+
- Does the interface come up?
48
+
- Does the expected device appear in Linux?
49
+
- Does the measured value stay inside the expected range?
50
+
- Does the output match the selected boot target?
51
+
52
+
Each test should end with a clear **YES/NO** or pass/fail result. When a result is not clear, document the exact observation and mark the open question instead of hiding it behind a vague pass.
53
+
54
+
### Test bench
55
+
56
+
TODO: Describe publicly available test setup.
57
+
58
+
***
59
+
60
+
## 📁 Automated test scripts
61
+
62
+
The public [flipperone-testing](https://github.com/flipperdevices/flipperone-testing) repository contains scripts and test assets for RK3576-based boards. It includes a shared test runner, module directories for major subsystems, and a `results/` directory layout for generated reports.
63
+
64
+
To avoid duplicating a fast-changing list of implemented tests here, use the repository [README](https://github.com/flipperdevices/flipperone-testing/blob/dev/README.md) as the current index of available automated checks, supported modules, and report formats.
65
+
66
+
***
67
+
68
+
## How to contribute
69
+
70
+
The Testing sub-project accepts contributions in three forms:
71
+
***Comments on open task** with ideas, suggestions, and improvements.
72
+
***Testing and uploading test results** to open testing tasks.
73
+
***Pull requests for test improvements**.
74
+
75
+
76
+
77
+
### Comment on an open task
78
+
79
+
If you have an idea on how to improve a test, add missing setup details, or clarify expected results, comment on a relevant task in the [Testing project board](https://github.com/orgs/flipperdevices/projects/14).
80
+
81
+
::::hint{type="info"}
82
+
**⚠️ Contributions only — no flooding**
83
+
84
+
To keep collaboration productive, please keep comments on-topic. Open tasks are for contribution-related discussion only. If you have an idea or concern, first turn it into a concrete contribution and share it as a comment on a task. For general questions or discussions, you're always welcome to join the conversation on [social media](https://x.com/Flipper_RND) or [Discord](https://discord.com/invite/flipper)!
85
+
::::
86
+
87
+
88
+
89
+
If you have an idea on how to improve a test, add missing setup details, clarify expected results, or share a test report, comment on a **help wanted** task in the [Testing project board](https://github.com/orgs/flipperdevices/projects/14).
90
+
91
+
:::::WorkflowBlock
92
+
:::WorkflowBlockItem
93
+
**Pick a task.** In the [Testing GitHub project](https://github.com/orgs/flipperdevices/projects/14), browse the open tasks and click the one labeled **help wanted** that you want to contribute to.
94
+
:::
95
+
96
+
::::WorkflowBlockItem
97
+
**Write your suggestion or report.** In the comments section, clearly describe your contribution and, if helpful, attach screenshots, videos, code snippets, logs, result files, or links to a draft pull request.
98
+
99
+
**Attachment size limit:**
100
+
101
+
- Images: 10 MB
102
+
- Videos: 100 MB
103
+
::::
104
+
105
+
:::WorkflowBlockItem
106
+
**Click Comment** to submit.
107
+
:::
108
+
:::::
109
+
110
+
We review all comments carefully! We may ask additional questions about your idea in the task thread, so please watch for GitHub notifications in your email.
111
+
112
+
113
+
114
+
***
115
+
116
+
### Testing and reporting test results
117
+
118
+
Testing tasks are published in the [Task Tracker](https://github.com/orgs/flipperdevices/projects/14) with the **help wanted** label. Each testing task contains all essential testing requirements, as well as the expected format for submitting a test report.
119
+
120
+
Review the testing requirements and perform the test. Attach your test report as a comment in the task thread.
121
+
122
+
123
+
124
+
***
125
+
126
+
### Contribute via a pull request
127
+
128
+
129
+
130
+
Contributing via pull requests allows anyone to propose changes to the automated test scripts in the [flipperone-testing](https://github.com/flipperdevices/flipperone-testing) repository on to manual test descriptions in the [flipperone-docs](https://github.com/flipperdevices/flipperone-docs) repository.
131
+
132
+
133
+
::::WorkflowBlock
134
+
:::WorkflowBlockItem
135
+
**Fork and clone the repository** ([flipperone-testing](https://github.com/flipperdevices/flipperone-testing) for changing testing scripts or [flipperone-docs](https://github.com/flipperdevices/flipperone-docs) for changing manual test descriptions).
136
+
137
+
:::WorkflowBlockItem
138
+
**Make your changes** in the cloned repository.
139
+
:::
140
+
141
+
:::WorkflowBlockItem
142
+
**Open a pull request** to the repository.
143
+
:::
144
+
::::
145
+
146
+
We review all pull requests carefully! We may ask additional questions in the PR thread, so please watch for GitHub notifications in your email.
0 commit comments