File tree Expand file tree Collapse file tree 2 files changed +32
-6
lines changed
Expand file tree Collapse file tree 2 files changed +32
-6
lines changed Original file line number Diff line number Diff line change @@ -5,7 +5,7 @@ This repository serves as a **template** for setting up **C++ and Rust projects*
55It provides a ** standardized project structure** , ensuring best practices for:
66
77- ** Build configuration** with Bazel.
8- - ** Testing** (unit and integration tests ).
8+ - ** Testing** (Component and Feature Integration Tests ).
99- ** Documentation** setup.
1010- ** CI/CD workflows** .
1111- ** Development environment** configuration.
@@ -17,8 +17,8 @@ It provides a **standardized project structure**, ensuring best practices for:
1717| File/Folder | Description |
1818| ----------------------------------- | ------------------------------------------------- |
1919| ` README.md ` | Short description & build instructions |
20- | ` src/ ` | Source files for the module |
21- | ` tests/ ` | Unit tests (UT) and integration tests (IT) |
20+ | ` src/ ` | Source files and Unit Tests for the module |
21+ | ` tests/ ` | Component and Feature Integration Tests (CIT&FIT) |
2222| ` examples/ ` | Example files used for guidance |
2323| ` docs/ ` | Documentation (Doxygen for C++ / mdBook for Rust) |
2424| ` .github/workflows/ ` | CI/CD pipelines |
@@ -66,6 +66,20 @@ artifacts of the module.
6666
6767### 3️⃣ Run Tests
6868
69+ All tests:
70+
71+ ``` sh
72+ bazel test //...
73+ ```
74+
75+ Unit tests:
76+
77+ ``` sh
78+ bazel test //src/...
79+ ```
80+
81+ Component / Feature integration tests:
82+
6983``` sh
7084bazel test //tests/...
7185```
Original file line number Diff line number Diff line change @@ -44,8 +44,8 @@ Project Layout
4444
4545The module template includes the following top-level structure:
4646
47- - `src/ `: Main C++/Rust sources
48- - `tests/ `: Unit and integration tests
47+ - `src/ `: Main C++/Rust sources with Unit Tests
48+ - `tests/ `: Component and Feature Integration Tests
4949- `examples/ `: Usage examples
5050- `docs/ `: Documentation using `docs-as-code `
5151- `.github/workflows/ `: CI/CD pipelines
@@ -59,7 +59,19 @@ To build the module:
5959
6060 bazel build //src/...
6161
62- To run tests:
62+ To run all tests:
63+
64+ .. code-block :: bash
65+
66+ bazel test //...
67+
68+ To run Unit Tests:
69+
70+ .. code-block :: bash
71+
72+ bazel test //src/...
73+
74+ To run Component / Feature Integration Tests:
6375
6476.. code-block :: bash
6577
You can’t perform that action at this time.
0 commit comments