Add note about cleaning up code early
This commit is contained in:
parent
3489457845
commit
8a3d736ce2
1 changed files with 11 additions and 0 deletions
|
|
@ -7,6 +7,17 @@ easy to read and understand.
|
||||||
|
|
||||||
- Follow existing coding patterns so that code looks familiar to developers.
|
- 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.
|
## Use comments to document why code exists.
|
||||||
|
|
||||||
**Don't** use comments to translate self-explanatory code.
|
**Don't** use comments to translate self-explanatory code.
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue