From 8a3d736ce2d78ede0a665e00de0121be028474f8 Mon Sep 17 00:00:00 2001 From: Brad Treloar Date: Sat, 30 Aug 2025 23:41:33 +0930 Subject: [PATCH] Add note about cleaning up code early --- .../programming/general/coding-practices-for-teams.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/programming/general/coding-practices-for-teams.md b/docs/programming/general/coding-practices-for-teams.md index 6422a88..a2c03c7 100644 --- a/docs/programming/general/coding-practices-for-teams.md +++ b/docs/programming/general/coding-practices-for-teams.md @@ -7,6 +7,17 @@ easy to read and understand. - Follow existing coding patterns so that code looks familiar to developers. +## Submit your final draft, not your first draft. + +Clean up code before merging it. + +Developers don't always get the opportunity to go back and clean up messy code +after it has been merged in. As far as business is concerned, the work is done, +move on to the next work item. + +1. Write code that works. +2. Refactor it to make it maintainable. + ## Use comments to document why code exists. **Don't** use comments to translate self-explanatory code.