Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Show the commit message body #83

Merged
merged 1 commit into from
Apr 14, 2023
Merged

Conversation

draftcode
Copy link
Contributor

Currently we show the commit message subjects (the first line of the
message) as the comment in the PR message editor. This shows the message
body as well. This is useful when there are multiple commits or when
there is a PR template (.github/PULL_REQUEST_TEMPLATE.md) exists.

Currently we show the commit message subjects (the first line of the
message) as the comment in the PR message editor. This shows the message
body as well. This is useful when there are multiple commits or when
there is a PR template (.github/PULL_REQUEST_TEMPLATE.md) exists.
@aviator-app
Copy link
Contributor

aviator-app bot commented Apr 14, 2023

Current Aviator status

Aviator will automatically update this comment as the status of the PR changes.
Comment /aviator refresh to force Aviator to re-examine your PR (or learn about other /aviator commands).

This PR was merged using Aviator.

@draftcode draftcode requested a review from a team April 14, 2023 00:46
Copy link
Contributor

@twavv twavv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there context for why you're adding this change? I'd imagine the commit titles would be enough to see what you're about to open a PR for. I worry that including the commit messages will make it harder to read.

@draftcode
Copy link
Contributor Author

draftcode commented Apr 14, 2023

I usually make one commit that 1st line as a title and the rest is the detail. If there is no PR template, av-cli takes them as the title and description.

The problem is when there is a PR template. Then the description is populated with the PR template and I cannot see the commit's detail part.

I think this change wouldn't affect multiple commits readability much because if people put multiple commits, they would only put titles. This change won't make any difference if a commit message is only one line.

If a person puts more than one line on a commit message and they want those detailed commits in one PR, this change will have lengthy pre-populated text (as a comment). First of all, I feel like if each commit requires such a lengthy explanation, it's better to be an independent PR, not one PR. But even if they want them to be in one PR, it's helpful for explaining the overall PR description to reference individual commits (if each commit has such huge changes that requires more than one line description).

@twavv
Copy link
Contributor

twavv commented Apr 14, 2023

Fair enough!

@aviator-app aviator-app bot merged commit df7fc3d into master Apr 14, 2023
@aviator-app aviator-app bot deleted the show-commit-message-body branch April 14, 2023 20:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants