Skip to content

Commit dd76ff4

Browse files
committed
Minor fixes
1 parent bc37d61 commit dd76ff4

2 files changed

Lines changed: 25 additions & 30 deletions

File tree

8.61 KB
Loading

docs/testing/About-Testing.md

Lines changed: 25 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ The Testing sub-project covers checks for RK3576-based boards used in Flipper On
1313
The Testing sub-project consists of:
1414

1515
-[Task tracker](https://github.com/orgs/flipperdevices/projects/14)
16-
- 📚 [Descriptions for manual tests](./#descriptions-for-manual-tests)
17-
- 📁 [Scripts for automated tests](https://github.com/flipperdevices/flipperone-testing)
16+
- 📚 [Manual test descriptions](./#manual-test-descriptions)
17+
- 📁 [Automated test scripts](https://github.com/flipperdevices/flipperone-testing)
1818

1919
***
2020

@@ -26,7 +26,7 @@ The public [Testing project board](https://github.com/orgs/flipperdevices/projec
2626

2727
***
2828

29-
## 📚 Descriptions for manual tests
29+
## 📚 Manual test descriptions
3030

3131
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.
3232

@@ -57,7 +57,7 @@ TODO: Describe publicly available test setup.
5757

5858
***
5959

60-
## 📁 Scripts for automated tests
60+
## 📁 Automated test scripts
6161

6262
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.
6363

@@ -67,14 +67,21 @@ To avoid duplicating a fast-changing list of implemented tests here, use the rep
6767

6868
## How to contribute
6969

70-
The Testing sub-project accepts contributions in three forms: **comments on open tasks**, **new issues**, and **pull requests for code changes** to the automated testing scripts.
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+
7176

7277
### Comment on an open task
7378

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+
7481
::::hint{type="info"}
7582
**⚠️ Contributions only — no flooding**
7683

77-
To keep collaboration productive, please keep issues and comments on-topic — they 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 an existing task or as a new issue. 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)!
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)!
7885
::::
7986

8087
![Contribute a comment on an open task](/files/pics/cpu-contribute-a-comment.jpg)
@@ -102,49 +109,37 @@ If you have an idea on how to improve a test, add missing setup details, clarify
102109

103110
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.
104111

112+
113+
105114
***
106115

107-
### Open a new issue
116+
### Testing and reporting test results
108117

109-
If you find a testing bug, missing automated check, or repeatable test idea that does not already have an open task, search the [flipperone-testing issues](https://github.com/flipperdevices/flipperone-testing/issues) first to confirm it has not already been reported, then open a new issue.
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.
110119

111-
::::WorkflowBlock
112-
:::WorkflowBlockItem
113-
**Search existing issues** in the [flipperone-testing repository](https://github.com/flipperdevices/flipperone-testing/issues) to make sure your bug or proposal has not already been reported.
114-
:::
120+
Review the testing requirements and perform the test. Attach your test report as a comment in the task thread.
115121

116-
:::WorkflowBlockItem
117-
**Open a new issue.** Click **New issue** and provide enough detail to reproduce the problem or understand the proposal — board revision, OS image or firmware build, command, expected result, actual result, screenshots, logs, or generated reports where relevant.
118-
:::
119-
120-
:::WorkflowBlockItem
121-
**Follow the discussion.** Watch the issue for notifications — we may ask clarifying questions.
122-
:::
123-
::::
122+
124123

125124
***
126125

127-
### Contribute to flipperone-testing via a pull request
126+
### Contribute via a pull request
128127

129128
![Contribute via a pull request](/files/pics/testing-contribute-via-pr.jpg)
130129

131-
Contributing via pull requests allows anyone to propose changes to the automated test scripts in the public [flipperone-testing](https://github.com/flipperdevices/flipperone-testing) repository.
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.
132131

133-
::::WorkflowBlock
134-
:::WorkflowBlockItem
135-
**Fork and clone the** [flipperone-testing](https://github.com/flipperdevices/flipperone-testing) **repository.**
136-
:::
137132

133+
::::WorkflowBlock
138134
:::WorkflowBlockItem
139-
**Make your changes** in the cloned repository. Update the repository README or result format documentation if your script change needs it.
140-
:::
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).
141136

142137
:::WorkflowBlockItem
143-
**Run the relevant test or script check** and save the command, result files, logs, or screenshots that show what changed.
138+
**Make your changes** in the cloned repository.
144139
:::
145140

146141
:::WorkflowBlockItem
147-
**Open a pull request** to the flipperone-testing repository and include the command you ran plus the result files or logs in the pull request description.
142+
**Open a pull request** to the repository.
148143
:::
149144
::::
150145

0 commit comments

Comments
 (0)