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

📝 Update commits guide #75

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

📝 Update commits guide #75

wants to merge 1 commit into from

Conversation

dankolbman
Copy link
Contributor

Updates commit guide with some results following discussion on git standards.

@dankolbman dankolbman added the documentation Regarding developer or user documentation label May 14, 2019
@dankolbman dankolbman requested review from fiendish and znatty22 May 14, 2019 15:28
@dankolbman dankolbman self-assigned this May 14, 2019
@dankolbman
Copy link
Contributor Author

Needs #76 so that emojis don't break the linter.

docs/guides/commit_messages.rst Outdated Show resolved Hide resolved
docs/guides/commit_messages.rst Outdated Show resolved Hide resolved
docs/guides/commit_messages.rst Outdated Show resolved Hide resolved
docs/guides/commit_messages.rst Outdated Show resolved Hide resolved
@dankolbman dankolbman force-pushed the update-commits branch 4 times, most recently from 7e4edcf to f111311 Compare May 16, 2019 15:19
@dankolbman dankolbman requested a review from znatty22 May 16, 2019 15:23
Copy link
Member

@znatty22 znatty22 left a comment

Choose a reason for hiding this comment

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

👍

counting the markdown tag emoji as only one charecter) line summarizing the
nature of the commit.
It should start with an appropriate emoji followed by a space
then a short summary of the change made in the commit.
When adding an emoji to the commit message, use the colon-ated version as
opposed to the actual unicode symbol, eg: `:sparkles:`. For inspiration of what
Copy link
Contributor

@fiendish fiendish May 16, 2019

Choose a reason for hiding this comment

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

The set of systems that understand unicode is much larger than the set of systems that dynamically convert shortcodes to their glyphs. Using shortcodes guarantees that git log won't show them properly, whereas all a person needs to do to ensure glyph display is join the past two decades with a unicode-capable font.

Copy link
Member

Choose a reason for hiding this comment

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

Using shortcodes guarantees that git log won't show them properly

What do you mean won't show them properly? Bc of line length or bc it won't render the glyphs?

Copy link
Contributor

Choose a reason for hiding this comment

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

doesn't convert shortcodes into glyphs

Copy link
Member

Choose a reason for hiding this comment

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

yea git log doesn't but our terminals render them correctly. i thought thats what we saw the other day

Copy link
Contributor

@fiendish fiendish May 16, 2019

Choose a reason for hiding this comment

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

terminals render unicode emojis. terminals do not convert ascii shortcodes into unicode emojis.

Copy link
Contributor

@fiendish fiendish May 16, 2019

Choose a reason for hiding this comment

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

copy and paste ":smile:" into your terminal and see what it prints. now paste 😄. Only the latter will actually show a picture of a face.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Regarding developer or user documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants