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

Wrap commit body in code area in PR message #150

Closed

Conversation

leoluk
Copy link
Collaborator

@leoluk leoluk commented Dec 9, 2021

Stack:

Commit messages are not guaranteed to be valid Markdown.
Wrapping them in a code area guarantees that the original
formatting is preserved (say, ASCII art).

This matches what GitHub itself does when rendering commits.

This might be a matter of taste - maybe some people *do*
write valid Markdown in their commits and want to keep the
existing behavior - should we make it a config option?

⚠️ Part of a stack created by spr. Do not merge manually using the UI - doing so may have unexpected results.

@ejoffe
Copy link
Owner

ejoffe commented Dec 9, 2021

I have never seen anyone use markdown in commit messages, so I'm good with this.
We can add it as a configuration layer if there is a need for markdown commit message support.

Commit messages are not guaranteed to be valid Markdown.
Wrapping them in a code area guarantees that the original
formatting is preserved (say, ASCII art).

This matches what GitHub itself does when rendering commits.

This might be a matter of taste - maybe some people *do*
write valid Markdown in their commits and want to keep the
existing behavior - should we make it a config option?

commit-id:33d44b17
@leoluk leoluk changed the base branch from pr/leoluk/develop/36d19c89 to master December 13, 2021 13:05
@leoluk leoluk changed the base branch from master to pr/leoluk/develop/36d19c89 December 13, 2021 13:05
@leoluk
Copy link
Collaborator Author

leoluk commented Dec 18, 2021

✓ Commit merged in pull request #156

@leoluk leoluk closed this Dec 18, 2021
@leoluk leoluk deleted the pr/leoluk/develop/33d44b17 branch December 18, 2021 11:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants