4 GitHub tips that I follow, that you’ll thank yourself later for too!
1. Descriptive branch names
Try to keep your branch name concise but clearly written that has these keywords (wherever applicable):
- Bug or Feature
- Ticket Number
- Functional area on which the branch is based.
❌ bug-fixes
✅ bug-T123-user-account
2. Add detailed commit messages
Write brief but descriptive messages to avoid digging the code later to understand its goal. Follow these 3 Ws - Why, Where & What
❌ Fixed validation issue
✅ Fixed issue of accurate error messages not showing on the Registration section.
3. Split Commits
Split commits for a particular section/branch based on the working module maybe every couple of hours. This will be easier in the future to track down what went wrong after some changes.
Avoid committing everything in 1 commit as it's not a good practice.
4. Descriptive PRs
Try to add as much information as possible in the PRs & add these:
- Ticket links
- Goal of the PR
- Detailed description of the things achieved (add bullet points if needed)
- Status if anything still remains to be done.
Also, address the PR reviews given
That's it for today!
Hope this has helped you out in case you were not following any of the above.
Note: This is not just specific to GIT, but can be used on any code versioning tool!
If you liked this, do visit me on Twitter to read some of my tweets 😊