Use emoji to illustrate good and bad example commit messages #1235
Conversation
This file contains 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
AlexWaygood
approved these changes
Dec 1, 2023
|
PDF builds used to have issues with emojis, and even other Unicode characters. |
|
Good reminder. There's also the epub builds for CPython (but I think they might be broken). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Makes it clear which are the good and bad examples.
✅ Doesn't rely on colour: colour blind people can still see a tick or cross
✅ We don't rely on them: the good/bad meaning is still clear from the text
Details
Details
Compare, for example, the Google developer docs: https://developers.google.com/style/ui-elements
Also fix some formatting.
📚 Documentation preview 📚: https://cpython-devguide--1235.org.readthedocs.build/