You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
cd /tmp/ravendb-source-<NUMBER>&& gh pr checkout <NUMBER>
54
54
```
55
55
56
-
After cloning, you have **full access** to the entire product codebase at `/tmp/ravendb-source/`.
56
+
After cloning, you have **full access** to the entire product codebase at `/tmp/ravendb-source-<NUMBER>/`.
57
57
Use `Read`, `Glob`, and `Grep` on this path to:
58
58
- Read complete source files (not just diffs)
59
59
- Browse related/unchanged code for context (base classes, interfaces, callers)
60
60
- Search the entire codebase for patterns, usages, and references
61
61
- Read test files for real usage examples and expected behavior
62
62
63
-
**Important**: The docs repo remains your working directory (`D:\workspaces\docs`). The cloned product repo is read-only reference material at `/tmp/ravendb-source/`.
63
+
**Important**: The docs repo remains your working directory (`D:\workspaces\docs`). The cloned product repo is read-only reference material at `/tmp/ravendb-source-<NUMBER>/`.
64
64
65
65
## Phase 3 — Classify Changes
66
66
@@ -138,16 +138,16 @@ Based on the changed files, classify the PR as one or more of:
138
138
139
139
## Phase 5 — Explore Source Code
140
140
141
-
After user confirmation, use the cloned repo at `/tmp/ravendb-source/` to deeply understand the changes.
141
+
After user confirmation, use the cloned repo at `/tmp/ravendb-source-<NUMBER>/` to deeply understand the changes.
142
142
143
143
### Read the changed files in full
144
144
For each file identified in Phase 2, read the complete source file (not just the diff) to understand the full API surface:
Use `Glob` and `Grep` on `/tmp/ravendb-source/` to find:
150
+
Use `Glob` and `Grep` on `/tmp/ravendb-source-<NUMBER>/` to find:
151
151
- Base classes, interfaces, and abstract types that changed code extends
152
152
- Other callers or usages of the modified API
153
153
- Configuration key registrations and default values
@@ -156,7 +156,7 @@ Use `Glob` and `Grep` on `/tmp/ravendb-source/` to find:
156
156
### Get a high-level diff overview
157
157
Use the base branch from the PR metadata (`baseRefName` from Phase 2) — it may be `v6.2`, `v7.1`, etc., not necessarily `main`:
158
158
```bash
159
-
cd /tmp/ravendb-source && git diff origin/<BASE_BRANCH>...HEAD --stat
159
+
cd /tmp/ravendb-source-<NUMBER>&& git diff origin/<BASE_BRANCH>...HEAD --stat
160
160
```
161
161
162
162
### Prioritize reading
@@ -244,7 +244,30 @@ After making changes:
244
244
245
245
### Clean up the cloned repo
246
246
```bash
247
-
rm -rf /tmp/ravendb-source
247
+
rm -rf /tmp/ravendb-source-<NUMBER>
248
+
```
249
+
250
+
### Commit the changes
251
+
252
+
The commit message **must** start with an issue number prefix:
253
+
-**`RavenDB-XXXXX`** — extract from the PR title, branch name, or body (e.g., PR title "RavenDB-25962 - Add vector search support" → prefix is `RavenDB-25962`)
254
+
-**`RDoc-XXXXX`** — if the documentation change has its own tracking issue
255
+
256
+
To find the issue number, check (in order):
257
+
1. The PR title (most common — e.g., "RavenDB-25962 - ...")
258
+
2. The PR branch name (e.g., `RavenDB-25962-vector-search`)
259
+
3. The PR body/description
260
+
261
+
**If no issue number can be found**, ask the user to provide either a `RavenDB-XXXXX` or `RDoc-XXXXX` number before committing.
262
+
263
+
Commit message format:
264
+
```
265
+
<ISSUE-NUMBER> - <short description of documentation changes>
266
+
```
267
+
268
+
Example:
269
+
```
270
+
RavenDB-25962 - Document vector search query API and configuration options
0 commit comments