Fix: README.md and directory

The current proposal doesn't work with provided instructions.

Author: nradakovic

BUILD

@@ -1,8 +1,25 @@
+# *******************************************************************************
+# Copyright (c) 2025 Contributors to the Eclipse Foundation
+#
+# See the NOTICE file(s) distributed with this work for additional
+# information regarding copyright ownership.
+#
+# This program and the accompanying materials are made available under the
+# terms of the Apache License Version 2.0 which is available at
+# https://www.apache.org/licenses/LICENSE-2.0
+#
+# SPDX-License-Identifier: Apache-2.0
+# *******************************************************************************
 load("@score_cr_checker//:cr_checker.bzl", "copyright_checker")
 
 copyright_checker(
-    name = "copyright_check",
-    srcs = ["src"],
+    name = "copyright",
+    srcs = [
+        "src",
+        "tests",
+        "//:BUILD",
+        "//:MODULE.bazel",
+    ],
     template = "@score_cr_checker//resources:templates",
     config = "@score_cr_checker//resources:config",
     visibility = ["//visibility:public"],

MODULE.bazel

@@ -1,12 +1,22 @@
+# *******************************************************************************
+# Copyright (c) 2025 Contributors to the Eclipse Foundation
+#
+# See the NOTICE file(s) distributed with this work for additional
+# information regarding copyright ownership.
+#
+# This program and the accompanying materials are made available under the
+# terms of the Apache License Version 2.0 which is available at
+# https://www.apache.org/licenses/LICENSE-2.0
+#
+# SPDX-License-Identifier: Apache-2.0
+# *******************************************************************************
 module(name = "cpp_rust_template_repository", version = "1.0")
 
-
 # Add GoogleTest dependency
 bazel_dep(name = "googletest", version = "1.14.0")
 
 # Rust rules for Bazel
 bazel_dep(name = "rules_rust", version = "0.56.0")
 
-
 # Add your custom module from the bazel_registry
 bazel_dep(name = "score_cr_checker", version = "0.2.0")

README.md

@@ -2,6 +2,7 @@
 
 This repository serves as a **template** for setting up **C++ and Rust projects** using **Bazel**.
 It provides a **standardized project structure**, ensuring best practices for:
+
 - **Build configuration** with Bazel.
 - **Testing** (unit and integration tests).
 - **Documentation** setup.
@@ -14,49 +15,71 @@ The template includes a **basic "Hello World" example** for both **C++ and Rust*
 
 ## 📂 Project Structure
 
-| File/Folder           | Description |
-|-----------------------|-------------|
-| `README.md`          | Short description & build instructions |
-| `src/`               | Source files for the module |
-| `tests/`             | Unit tests (UT) and integration tests (IT) |
-| `docs/`              | Documentation (Doxygen for C++ / mdBook for Rust) |
-| `.github/workflows/`  | CI/CD pipelines |
-| `.vscode/`           | Recommended VS Code settings |
-| `.bazelrc`, `MODULE.bazel`, `BUILD` | Bazel configuration & settings |
-| `LICENSE.md`         | Licensing information |
-| `CONTRIBUTION.md`    | Contribution guidelines |
+| File/Folder                         | Description                                       |
+| ----------------------------------- | ------------------------------------------------- |
+| `README.md`                         | Short description & build instructions            |
+| `examples/`                         | Examples how to invoke targets of the module      |
+| `src/`                              | Source files for the module                       |
+| `tests/`                            | Unit tests (UT) and integration tests (IT)        |
+| `docs/`                             | Documentation (Doxygen for C++ / mdBook for Rust) |
+| `.github/workflows/`                | CI/CD pipelines                                   |
+| `.vscode/`                          | Recommended VS Code settings                      |
+| `.bazelrc`, `MODULE.bazel`, `BUILD` | Bazel configuration & settings                    |
+| `LICENSE.md`                        | Licensing information                             |
+| `CONTRIBUTION.md`                   | Contribution guidelines                           |
 
 ---
 
 ## 🚀 Getting Started
 
 ### 1️⃣ Clone the Repository
+
 ```sh
 git clone https://github.com/eclipse-score/YOUR_PROJECT.git
 cd YOUR_PROJECT
 ```
 
-### 2️⃣ Build the Project
-#### C++
+### 2️⃣ Build the Examples of module
+
+> DISCLAMER: Depending what module implements, it's possible that different
+> configuration flags needs to be set on command line.
+
+To build all targets of the module the following command can be used:
+
 ```sh
-bazel build //...
+bazel build //src/...
 ```
-#### Rust
+
+This command will instruct Bazel to build all targets that are under Bazel
+package `src/`. The ideal solution is to provide single target that builds
+artifacts, for example:
+
 ```sh
-bazel build //rust/...
+bazel build //src/<module_name>:release_artifacts
 ```
 
+where `:release_artifacts` is filegroup target that collects all release
+artifacts of the module.
+
+> NOTE: This is just proposal, the final decision is on module maintainer how
+> the module code needs to be built.
+
 ### 3️⃣ Run the Example
+
 #### C++
+
 ```sh
 bazel run //src:main
 ```
+
 #### Rust
+
 ```sh
 bazel run //rust:main
 ```
 
 ### 4️⃣ Run Tests
+
 ```sh
 bazel test //tests/...
 ```

src/BUILD

@@ -1,3 +1,15 @@
+# *******************************************************************************
+# Copyright (c) 2025 Contributors to the Eclipse Foundation
+#
+# See the NOTICE file(s) distributed with this work for additional
+# information regarding copyright ownership.
+#
+# This program and the accompanying materials are made available under the
+# terms of the Apache License Version 2.0 which is available at
+# https://www.apache.org/licenses/LICENSE-2.0
+#
+# SPDX-License-Identifier: Apache-2.0
+# *******************************************************************************
 cc_test(
     name = "cpp_test_main",
     srcs = ["test_main.cpp"],

src/cpp/BUILD

@@ -1,3 +1,15 @@
+/********************************************************************************
+* Copyright (c) 2025 Contributors to the Eclipse Foundation
+*
+* See the NOTICE file(s) distributed with this work for additional
+* information regarding copyright ownership.
+*
+* This program and the accompanying materials are made available under the
+* terms of the Apache License Version 2.0 which is available at
+* https://www.apache.org/licenses/LICENSE-2.0
+*
+* SPDX-License-Identifier: Apache-2.0
+********************************************************************************/
 #include <gtest/gtest.h>
 
 // Function to be tested