Add Real-World Project: Changelog Generator from Git History - #277
Open
abderrahim-lectures wants to merge 1 commit into
Open
Add Real-World Project: Changelog Generator from Git History#277abderrahim-lectures wants to merge 1 commit into
abderrahim-lectures wants to merge 1 commit into
Conversation
New Real-World Project (backlog idea #19). Full lesson plus a runnable tool that fetches commit history with git log and synthesizes a clean, categorized changelog with a free-tier LLM, citing a commit hash for every entry so nothing can be invented. Closes #276 Co-authored-by: deepseek-v4-flash-free <noreply@opencode.ai>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a new Real-World Projects lesson: Build a Changelog Generator from Git History (backlog idea #19).
What's included
docs/projects/changelog-from-git/index.md— full lesson in the house skeleton. Core idea: the 'documents' are commit messages fetched bygit log, each already atomic (no chunking), and the real challenge is judgment under noisy input — grouping, de-duplicating, and phrasing without inventing. The prompt demands categorized sections plus a commit-hash citation per entry, and a dedicated verification step checks the changelog against the real log.docs/projects/changelog-from-git/_category_.jsonexamples/changelog-from-git/— runnable tool:fetch_commits.py(NUL-separatedgit log --format),generate.py(6-provider LLM support),make_sample_repo.py(builds a 14-commit sample repo with realistic noise: wip/tweak/merge, gitignored and recreated),notebook.ipynb, README, pyproject/uv.lock.src/data/projects.ts,docs/projects/index.mdx,src/pages/index.tsx(English only — i18n in a follow-up PR).Verification
make_sample_repo.pytested: creates 14 messy commits;fetch_commits.pyparses them cleanly (hash/date/author/subject per record).npm run typecheckandnpm run buildpass (all 4 locales, no broken links).Closes #276