CONTRIBUTING: Improve commit description example

smogon · Feb 13, 2017 · 4d5aac8 · 4d5aac8
1 parent 99440d9
commit 4d5aac8
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -21,8 +21,10 @@ Commits should describe what the code _does_, not how it does it.
 
 In other words:
 
-- BAD: `Add UU format slices`
-- GOOD: `Teambuilder: Add UU tier list`
+- BAD: `Change Wonder Guard from onBeforeMove to onTryHit`
+- GOOD: `Fix Mold Breaker Wonder Guard interaction`
+
+The details of how you achieve the fix should be left for the second paragraph of the commit message.
 
 If this is not possible because your code does not make any functionality changes, your commit summary should ideally start with the word "Refactor" (or at least it contain it in some way).