dotfiles

andersuno
git clone git://git.andersuno.nu/dotfiles.git
Log | Files | Refs | README

SKILL.md (1020B)


      1 ---
      2 name: git-commiter
      3 description: Write descriptive but managable git commit messages
      4 ---
      5 
      6 ## Commit Message Guidelines
      7 
      8 - The subject line must be **≤ 50 characters** (includes whitespace).
      9 - Include a descriptive body
     10 - Write in imperative mood and start with a capital letter.
     11 - Do not end the subject with a period.
     12 - Separate subject and body with a blank line.
     13 
     14 ## Body Rules
     15 
     16 - Each body line ≤ 72 characters.
     17 - Use `-m` for each paragraph when committing from CLI.
     18   Example:
     19   ```
     20   git commit -m "Subject" -m "Body paragraph 1" -m "Body paragraph 2"
     21   ```
     22 
     23 ## Useful commands
     24 
     25 - Use `git commit --amend` to modify the most recent commit.
     26   ```
     27   git commit --amend -m "New subject" -m "New body"
     28   ```
     29 - To view the last commit verbatim, run:
     30   ```
     31   git log -1 --pretty=full
     32   ```
     33 
     34 ## Remember
     35 
     36 - Avoid using `git commit -a` unless you know what you’re committing.
     37 - Keep messages focused; explain *what* was done and *why* it matters.
     38 - Show the plan first.
     39 - Do not commit until the user confirms.
     40