1# Phase 7: Commit and Open PR
2
3You are creating a git branch, committing documentation changes, and opening a PR.
4
5## Objective
6Package documentation updates into a reviewable pull request.
7
8## Input
9You will receive:
10- Summary from Phase 6
11- List of modified files
12
13## Instructions
14
151. **Create Branch**
16 ```sh
17 git checkout -b docs/auto-update-{date}
18 ```
19 Use format: `docs/auto-update-YYYY-MM-DD` or `docs/auto-update-{short-sha}`
20
212. **Stage and Commit**
22 - Stage only documentation files in `docs/src/`
23 - Do not stage any other files
24
25 Commit message format:
26 ```
27 docs: auto-update documentation for [brief description]
28
29 [Summary from Phase 6, condensed]
30
31 Triggered by: [commit SHA or PR reference]
32
33 Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>
34 ```
35
363. **Push Branch**
37 ```sh
38 git push -u origin docs/auto-update-{date}
39 ```
40
414. **Create Pull Request**
42 Use the Phase 6 summary as the PR body.
43
44 PR Title: `docs: [Brief description of documentation updates]`
45
46 Labels (if available): `documentation`, `automated`
47
48 Base branch: `main`
49
50## Constraints
51- Do NOT auto-merge
52- Do NOT request specific reviewers (let CODEOWNERS handle it)
53- Do NOT modify files outside `docs/src/`
54- If no changes to commit, exit gracefully with message "No documentation changes to commit"
55
56## Output
57```markdown
58## PR Created
59
60- **Branch**: docs/auto-update-{date}
61- **PR URL**: https://github.com/zed-industries/zed/pull/XXXX
62- **Status**: Ready for review
63
64### Commit
65- SHA: {commit-sha}
66- Files: {count} documentation files modified
67```