Created
September 13, 2021 16:49
-
-
Save allenluce/c7f74ac3b5899ccff7cfc4eaba1b7f35 to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Hey devs! I got a chance to look a little at the work being done in the lesson-creation-deliver repo and have a few recommendations for you: | |
1) Do not merge into your feature branch! | |
Doing so convolutes Git history and destroys one of the most valuable | |
tools available for diagnosing bugs. Instead, use rebase. This keeps | |
history clean and keeps your changes separate from those on other | |
branches. | |
2) Write commit messsages! Make them LONG, make them VERBOSE, and explain why you did EVERYTHING that you did in the commit! | |
Unlike JIRA tickets, Wiki pages, emails, meeting notes or anything | |
else, commit messages are the one thing you can be sure that will be | |
there in the future to explain why you did what you did in the | |
commit. If there's any question in your mind, err on the side of | |
writing too much in the commit message. The next dev who has to deal | |
with your code will thank you! (Also keep in mind that the next dev | |
might be you!) | |
3) Write tests as you code | |
Tests are the great enabler of modern software development. They allow | |
you to understand your interfaces, your code's behavior, and whether | |
its doing the right thing or not. Tests unlock rapid and reliable | |
refactoring. They protect your code from bugs that others might | |
introduce. Never skimp on test code! Write tests as you are coding, | |
and NOT after you finish everything! Your job is not done until your | |
code is tested. | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment