Skip to content

Commit 3a9314f

Browse files
committed
Document PR review and merge workflow in CLAUDE.md
1 parent db637a9 commit 3a9314f

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

CLAUDE.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,24 @@ cargo test -- --ignored
9797

9898
5. **Streaming**: Use `get_object_stream` and `put_object_stream` methods for large files to avoid loading entire content in memory.
9999

100+
## PR Review and Merge Workflow
101+
102+
When reviewing and merging external PRs, follow this workflow to preserve contributor credit while testing locally before merging to master:
103+
104+
1. **Review** - `gh pr view <number>` and `gh pr diff <number>`
105+
2. **Test locally** - `gh pr checkout <number>`, run tests
106+
3. **Switch to release branch** - `git checkout <release-branch>`
107+
4. **Cherry-pick with authorship preserved**:
108+
```bash
109+
git cherry-pick -x <commit-sha>
110+
```
111+
The `-x` flag adds "(cherry picked from commit ...)" and preserves the original author.
112+
113+
5. **Add your changes** (tests, fixes, etc.) as separate commits
114+
6. **When ready to release** - merge release branch to master. Include "Closes #xxx" in commit messages so PRs auto-close.
115+
116+
**Important**: Don't use `git merge --squash` locally - it loses the PR association. Either cherry-pick (preserves author) or merge via GitHub (`gh pr merge --squash`) which properly closes PRs and credits contributors.
117+
100118
## Code Conventions
101119

102120
- Use existing error types from `s3/src/error.rs`

0 commit comments

Comments
 (0)