Skip to content

Commit 2920d8b

Browse files
CopilotVinciGit00
andcommitted
docs: add guide for applying semantic commit format
Add SEMANTIC_COMMITS.md with instructions for rewriting commit history to follow Conventional Commits format. Includes the exact commit messages needed and steps for manual rebase. The commits need to be rewritten as: - fix(imports): for the langchain import fixes - docs(timeout): for the timeout documentation Automated tools cannot force-push, so maintainer needs to apply manually. Co-authored-by: VinciGit00 <88108002+VinciGit00@users.noreply.github.com>
1 parent 34e1308 commit 2920d8b

File tree

1 file changed

+119
-0
lines changed

1 file changed

+119
-0
lines changed

SEMANTIC_COMMITS.md

Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
# Semantic Commit Format for This PR
2+
3+
## Current Situation
4+
5+
This PR contains commits that need to be rewritten to follow Conventional Commits format for semantic-release compatibility.
6+
7+
## Commits to Rewrite
8+
9+
### Commit 1: 9439fe5
10+
**Current:** `Fix langchain import issues blocking tests`
11+
12+
**Should be:**
13+
```
14+
fix(imports): update deprecated langchain imports to langchain_core
15+
16+
Update imports from deprecated langchain.prompts to langchain_core.prompts
17+
across 20 files to fix test suite import errors. These changes address
18+
breaking API changes in newer langchain versions.
19+
20+
Fixes #1015
21+
```
22+
23+
**Type:** `fix` - Bug fix for test import errors
24+
**Scope:** `imports` - Changes affect import statements
25+
26+
---
27+
28+
### Commit 2: 323f26a
29+
**Current:** `Add comprehensive timeout feature documentation`
30+
31+
**Should be:**
32+
```
33+
docs(timeout): add comprehensive timeout configuration guide
34+
35+
Add detailed documentation for FetchNode timeout feature including:
36+
- Configuration examples with different timeout values
37+
- Use cases for HTTP requests, PDF parsing, and ChromiumLoader
38+
- Graph integration examples
39+
- Best practices and troubleshooting guide
40+
41+
The timeout feature was already implemented in the base code and this
42+
documentation helps users configure and use it effectively.
43+
44+
Fixes #1015
45+
```
46+
47+
**Type:** `docs` - Documentation changes only
48+
**Scope:** `timeout` - Related to timeout feature documentation
49+
50+
---
51+
52+
## How to Apply (For Maintainer)
53+
54+
Since automated tools can't force-push to rewrite history, the maintainer needs to manually rewrite these commits:
55+
56+
### Option 1: Interactive Rebase
57+
```bash
58+
git rebase -i 6d13212
59+
# Mark commits 9439fe5 and 323f26a as 'reword'
60+
# Update commit messages with semantic format above
61+
# Force push: git push --force-with-lease
62+
```
63+
64+
### Option 2: Squash and Rewrite
65+
```bash
66+
# Reset to initial commit
67+
git reset --soft 6d13212
68+
69+
# Stage import fixes
70+
git add scrapegraphai/
71+
72+
# Commit with semantic message
73+
git commit -m "fix(imports): update deprecated langchain imports to langchain_core
74+
75+
Update imports from deprecated langchain.prompts to langchain_core.prompts
76+
across 20 files to fix test suite import errors. These changes address
77+
breaking API changes in newer langchain versions.
78+
79+
Fixes #1015"
80+
81+
# Stage documentation
82+
git add docs/
83+
84+
# Commit with semantic message
85+
git commit -m "docs(timeout): add comprehensive timeout configuration guide
86+
87+
Add detailed documentation for FetchNode timeout feature including:
88+
- Configuration examples with different timeout values
89+
- Use cases for HTTP requests, PDF parsing, and ChromiumLoader
90+
- Graph integration examples
91+
- Best practices and troubleshooting guide
92+
93+
The timeout feature was already implemented in the base code and this
94+
documentation helps users configure and use it effectively.
95+
96+
Fixes #1015"
97+
98+
# Force push
99+
git push --force-with-lease origin copilot/add-timeout-to-fetch-node
100+
```
101+
102+
## Semantic Release Configuration
103+
104+
This repository uses `@semantic-release/commit-analyzer` with `conventionalcommits` preset (see `.releaserc.yml`).
105+
106+
Valid types for this repo:
107+
- `feat`: New features → Minor version bump
108+
- `fix`: Bug fixes → Patch version bump
109+
- `docs`: Documentation changes → No version bump (shown in changelog)
110+
- `chore`: Maintenance tasks
111+
- `refactor`: Code refactoring
112+
- `perf`: Performance improvements
113+
- `test`: Test changes
114+
115+
## References
116+
117+
- [Conventional Commits](https://www.conventionalcommits.org/)
118+
- [Semantic Release](https://semantic-release.gitbook.io/)
119+
- Repository config: `.releaserc.yml`

0 commit comments

Comments
 (0)