Skip to content

Commit 06c4d87

Browse files
committed
Clean up skills
1 parent 1d00926 commit 06c4d87

4 files changed

Lines changed: 21 additions & 17 deletions

File tree

.agents/skills/firebase-cpp-builder/SKILL.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@ This skill provides instructions on how to build the Firebase C++ SDK directly
1212
from source, specifically tailored for building individual products (like
1313
`firebase_auth`, `firebase_database`, etc.).
1414

15+
## Prerequisites
16+
17+
Before building, ensure that your Python environment is set up with all required dependencies, especially if you plan to use helper scripts:
18+
19+
- **Python Dependencies**: Run `pip install -r scripts/gha/python_requirements.txt` to install required libraries (such as `attrs`, `absl-py`, etc.).
20+
1521
## 1. Desktop Builds (Mac, Linux, Windows)
1622

1723
The easiest way to build for Desktop is to use the Python helper script from the

.agents/skills/firebase-cpp-commenting-standards/SKILL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Objective-C wrappers should also follow standard Doxygen conventions, especially
7070

7171
---
7272

73-
## checklist
73+
## Checklist
7474
- [ ] Are you using `///` for public API comments?
7575
- [ ] Do you have a `@brief` for the method?
7676
- [ ] Are all parameters documented with `@param`?

.agents/skills/firebase-cpp-formatter/SKILL.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@ This skill provides instructions on how to properly format C++ and Objective-C
1212
code before creating a pull request or committing changes in the
1313
`firebase-cpp-sdk` repository. The primary tool is `scripts/format_code.py`.
1414

15+
## Prerequisites
16+
17+
Before running the formatting script, ensure that your Python environment is set up with all required dependencies:
18+
19+
- **Python Dependencies**: Run `pip install -r scripts/gha/python_requirements.txt` to install the required libraries (such as `attrs`, `absl-py`, etc.).
20+
1521
## Workflows
1622

1723
### 1. Formatting Specific Changed Files (Git Diff)

.agents/skills/firebase-cpp-test-runner/SKILL.md

Lines changed: 8 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,11 @@ platforms.
1414

1515
## Prerequisites
1616

17-
Before building integration tests, ensure that you have the private Google
18-
Services configuration files present in the `integration_test/` directory of the
19-
product you are testing:
17+
Before building integration tests, ensure that your Python environment is set up with all required dependencies, and that you have the private Google Services configuration files present:
2018

21-
- **Android and Desktop**: `google-services.json` must be present.
22-
- **iOS**: `GoogleService-Info.plist` must be present.
23-
24-
_Note:_ If you are testing `auth`, you would place these files in
25-
`auth/integration_test/google-services.json` and
26-
`auth/integration_test/GoogleService-Info.plist`.
19+
- **Python Dependencies**: Run `pip install -r scripts/gha/python_requirements.txt` to install the required libraries (such as `attrs`, `absl-py`, etc.).
20+
- **Android and Desktop Config Files**: `google-services.json` must be present in `<product>/integration_test/`.
21+
- **iOS Config Files**: `GoogleService-Info.plist` must be present in `<product>/integration_test/`.
2722

2823
## Using the `build_testapps.py` Helper Script
2924

@@ -57,16 +52,13 @@ tests successfully.
5752

5853
### Building for Desktop
5954

60-
You can use `build_testapps.py` or the provided platform-specific convenience
61-
scripts for Desktop.
62-
63-
Alternatively, if you want to build the SDK manually via CMake:
55+
To build a desktop integration test application for a specific product (e.g., `auth`), run the following command from the repository root:
6456

6557
```bash
66-
python3 scripts/gha/build_desktop.py -a <arch> --build_dir <dir>
58+
python3 scripts/gha/build_testapps.py --p Desktop --t auth
6759
```
6860

69-
Use `python3 scripts/gha/build_desktop.py --help` for more options.
61+
You can specify the architecture with the `--arch` flag (e.g., `--arch x64`, `--arch x86`, or `--arch arm64`).
7062

7163
## Manual Integration Test Builds (Alternative)
7264

@@ -88,7 +80,7 @@ export FIREBASE_CPP_SDK_DIR=path_to_cpp_git_repo
8880
cd <product>/integration_test
8981
cp path_to_google_services_files/google-services.json .
9082
mkdir desktop_build && cd desktop_build
91-
cmake .. && cmake --build . -j
83+
cmake .. -DFIREBASE_CPP_SDK_DIR=/path/to/firebase_cpp_sdk && cmake --build . -j
9284
```
9385

9486
Once the build is finished, run the generated `integration_test` binary.

0 commit comments

Comments
 (0)