Skip to content

Commit db69d9b

Browse files
authored
chore: doc updates (#16)
1 parent d692ddc commit db69d9b

2 files changed

Lines changed: 1 addition & 29 deletions

File tree

CONTRIBUTING.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -301,11 +301,7 @@ New to the project? Look for issues labeled `good first issue`:
301301

302302
- **Questions**: Open a GitHub Discussion or Issue with `question` label
303303
- **Bugs**: Open an issue with reproduction steps
304-
- **Security**: See [SECURITY.md](SECURITY.md) (don't open public issues)
305-
306-
### Code of Conduct
307-
308-
Please follow our [Code of Conduct](CODE_OF_CONDUCT.md) in all interactions.
304+
- **Security**: For security concerns, please open a private security advisory on GitHub (don't open public issues)
309305

310306
## 🏆 Recognition
311307

tests/README.md

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,6 @@
22

33
This directory contains tests for the Databricks C++ SDK, organized by test type.
44

5-
## Structure
6-
7-
```
8-
tests/
9-
├── unit/ # Unit tests (fast, no external dependencies)
10-
│ └── test_client.cpp # Client & Config tests (Google Test)
11-
├── helpers/ # Test utilities and helpers
12-
│ └── test_utils.h # Common test utilities
13-
└── CMakeLists.txt # Test configuration
14-
```
15-
165
## Running Tests
176

187
### Build Tests
@@ -174,19 +163,6 @@ EXPECT_THROW({
174163
}, std::runtime_error);
175164
```
176165

177-
### Architecture: Dependency Injection
178-
179-
REST API clients (Compute, Jobs, etc.) support two constructors:
180-
181-
1. **Production**: `Compute(AuthConfig)` - Creates real HttpClient
182-
2. **Testing**: `Compute(std::shared_ptr<IHttpClient>)` - Accepts mock
183-
184-
This pattern enables:
185-
- ✅ Fast, deterministic unit tests
186-
- ✅ Testing without external dependencies
187-
- ✅ Easy error scenario simulation
188-
- ✅ Request/response verification
189-
190166
### Available Assertions
191167

192168
- `EXPECT_TRUE(condition)` / `EXPECT_FALSE(condition)`

0 commit comments

Comments
 (0)