Git
Git
How to Make a Good Commit
- Each commit should change a single thing.
Message
- Separate subject from body with a blank line.
- Limit the subject line to 50 characters.
- Capitalize the subject line.
- Do not end the subject line with a period.
- Use the imperative mood in the subject line.
- Wrap the body at 72 characters.
- Use the body to explain what and why vs. how.
How to Make a Good Pull Request
- Include the purpose of the Pull Request.
- Provide an overview of why the work is taking place. Give a good background on why the change is happening.
- Be explicit about what feedback you want, if any: a quick pair of :eyes: on the code, discussion on the technical approach, critique on design, a review of copy.
- Offering feedback
- Familiarize yourself with the context of the issue, and reasons why this Pull Request exists.
- Ask, don't tell.
- Explain your reasons why code should be changed.
- Be aware of negative bias with online Communication. Can you use positive language as opposed to neutral?
Resources
- Conventional Commits. A specification for adding human and machine readable meaning to commit messages.
- Conventional Comments. Comments that are easy to grok and grep.
- Semantic Pull Requests. Let the robots take care of the semantic versioning.
- Conventional Changelog. Generate changelogs and release notes from a project's commit messages and metadata
- Gitmoji. An emoji guide for your commit messages.