From 3c572ebafa74b56c2ef1e4bd9c147ee923f49e59 Mon Sep 17 00:00:00 2001 From: henrikvtcodes Date: Tue, 6 Aug 2024 13:52:02 -0500 Subject: [PATCH] add link to a guide for the micro commits standard --- docs/verso-standards/micro-commits.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/verso-standards/micro-commits.md b/docs/verso-standards/micro-commits.md index 325ceb3..543d358 100644 --- a/docs/verso-standards/micro-commits.md +++ b/docs/verso-standards/micro-commits.md @@ -18,12 +18,14 @@ To illustrate the process of micro-committing, here's a hypothetical situation w 3. **Make the code pretty:** Formatting, refactoring, etc. Things that make your code easier to read and fix at a later date. Commit after this is done, fixing any errors that cropped up beforehand. 4. Push to remote! (If you haven't already) +A good detailed guide: [A Practical Guide to Micro Commits | Niko Heikkila](https://world.hey.com/niko.heikkila/a-practical-guide-to-micro-commits-a37151eb) + ## Why? Many developers tend to make large, infrequent commits full of unrelated changes. This can make it hard to track how a project has evolved or how different parts of a codebase have changed. Some benefits include: -- **Reducing risk of losing work:** Frequently committing and pushing means that your work gets incrementally saved -- **Debugging via commits:** As you fix bugs or develop new features, small commits allow you to figure out (and revert) exactly what changes might be causing errors +- **Reducing risk of losing work:** Frequently committing and pushing means that your work gets incrementally saved. +- **Debugging via commits:** As you fix bugs or develop new features, small commits allow you to figure out (and revert) exactly what changes might be causing errors. - **Merge conflict resolution:** Resolving merge conflicts can be made easier via micro-committing, since the git merge algorithm has more information to work with. ## More information