Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This repository serves as a **template** for setting up **C++ and Rust projects*
It provides a **standardized project structure**, ensuring best practices for:

- **Build configuration** with Bazel.
- **Testing** (unit and integration tests).
- **Testing** (Component and Feature Integration Tests).
- **Documentation** setup.
- **CI/CD workflows**.
- **Development environment** configuration.
Expand All @@ -17,8 +17,8 @@ It provides a **standardized project structure**, ensuring best practices for:
| File/Folder | Description |
| ----------------------------------- | ------------------------------------------------- |
| `README.md` | Short description & build instructions |
| `src/` | Source files for the module |
| `tests/` | Unit tests (UT) and integration tests (IT) |
| `src/` | Source files and Unit Tests for the module |
| `tests/` | Component and Feature Integration Tests (CIT&FIT) |
| `examples/` | Example files used for guidance |
| `docs/` | Documentation (Doxygen for C++ / mdBook for Rust) |
| `.github/workflows/` | CI/CD pipelines |
Expand Down Expand Up @@ -66,6 +66,20 @@ artifacts of the module.

### 3️⃣ Run Tests

All tests:

```sh
bazel test //...
```

Unit tests:

```sh
bazel test //src/...
```

Component / Feature integration tests:

```sh
bazel test //tests/...
```
Expand Down
18 changes: 15 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ Project Layout

The module template includes the following top-level structure:

- `src/`: Main C++/Rust sources
- `tests/`: Unit and integration tests
- `src/`: Main C++/Rust sources with Unit Tests
- `tests/`: Component and Feature Integration Tests
- `examples/`: Usage examples
- `docs/`: Documentation using `docs-as-code`
- `.github/workflows/`: CI/CD pipelines
Expand All @@ -59,7 +59,19 @@ To build the module:

bazel build //src/...

To run tests:
To run all tests:

.. code-block:: bash

bazel test //...

To run Unit Tests:

.. code-block:: bash

bazel test //src/...

To run Component / Feature Integration Tests:

.. code-block:: bash

Expand Down
Loading