Skip to content

Instantly share code, notes, and snippets.

@marchershey

marchershey/webdevknowledge.md

Last active January 29, 2022 04:00
Show Gist options
  • Save marchershey/94810eb67e9ec94c0c34fd98fb81bd47 to your computer and use it in GitHub Desktop.
Save marchershey/94810eb67e9ec94c0c34fd98fb81bd47 to your computer and use it in GitHub Desktop.
Download ZIP
Web Development Knowledge Base
Raw
webdevknowledge.md

Commit and PR Types

Format: <type>(<scope>): <subject>

  • <scope> would be something like edit:(design) changed the styling of header on the base layout

Example

feat: added ability to edit users
^--^  ^------------^
|     |
|     +-> Summary in present tense.
|
+-------> Type: fix, feat, edit, refact, chore, build, test, docs, revert, or perf.
  • fix - Bug Fixes - A bug fix
  • feat - Features - A new feature
  • edit - Code Edits - Small changes to the code that do not drastically change results (e.g adding shadow, changing text color, etc)
  • refact - Refactoring - Changes to code without altering the results (e.g cleaning up unused code, removing whitespace, renaming variables/class names, adding code comments, etc)
  • chore - Chores - Any other changes that do not modify production code or tests (e.g dependencies, .gitignore, .vscode, etc)
  • build - Builds - Changes that affect the build system (e.g docker)
  • test - Tests - Adding or changing tests
  • docs - Documentation - Changes to documentation NOT code comments!
  • revert - Reverts - Reverting to a previous commit
  • perf - Performance Improvements - Changes that improve the performance

Reference: https://www.conventionalcommits.org/en/v1.0.0/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment