Github commit messages and commit descriptions are not descriptive enough. Expla#25
Closed
gokhanpicgeta wants to merge 1 commit into
Closed
Conversation
# Task Completion Summary
## Problem
GitHub pull requests created by the factory were not descriptive enough. They only contained a brief message about the factory run without explaining what changes were actually made in the commits.
## Solution
Enhanced the PR description generation in `factory/poller.py` to include a detailed "Changes" section that displays the commit log. This allows reviewers to immediately see what commits were made as part of the automated implementation.
## Files Changed
- `factory/poller.py` (lines 129-146): Modified `_push_and_pr()` function to:
1. Fetch the commit log between the base branch and the head branch using `git log`
2. Format the commit messages in a markdown code block
3. Include them in the PR body under a "Changes" section
## How It Works
When a PR is created:
1. The factory retrieves all commits unique to the current branch with `git log {base_branch}..HEAD --oneline`
2. These commits are formatted and added to the PR description
3. Reviewers can now see exactly what changes were made in the PR without having to check the branch directly
## Example Output
The PR description will now include:
```
## Changes
```
commit-hash commit message line 1
commit-hash commit message line 2
...
```
This provides transparency into what the factory implemented and helps reviewers understand the scope of changes at a glance.
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.
Automated implementation by Silverpond Factory (run
39cc1855).