Don’t waste hours programming / coding just to get your pull request rejected.
9 common mistakes I see in pull requests ( fixes provided ) :
9 common mistakes I see in pull requests ( fixes provided ) :
1. Incorrect or inconsistent formatting
This leads to messy code and is a big no-no.
Pay attention to the existing code and stick to the formatting standard in your company and repo.
This leads to messy code and is a big no-no.
Pay attention to the existing code and stick to the formatting standard in your company and repo.
2. Commented out code
If it’s not needed, just delete it.
If it’s not needed, just delete it.
3. Unnecessary comments
Comments can be handy but having too much just clutters the code.
Comments can be handy but having too much just clutters the code.
4. Left-over logs
Logs are handy for debugging and testing but we don’t want them in production so leave them out of your PRs.
Logs are handy for debugging and testing but we don’t want them in production so leave them out of your PRs.
5. Incomplete changes
All PRs should contain changes that are production-ready.
If it’s not production-ready then it’s not ready to review.
All PRs should contain changes that are production-ready.
If it’s not production-ready then it’s not ready to review.
6. Breaking changes
I’m sure this one doesn’t need an explanation.
I’m sure this one doesn’t need an explanation.
7. Including unrelated changes into the pull request
Everything in a PR should be related to a single set of changes. If it’s unrelated, it should be in its own PR.
Everything in a PR should be related to a single set of changes. If it’s unrelated, it should be in its own PR.
8. Letting the reviewer figure things out themselves
Always give an overview of the changes you’ve made and a bit of context about what they do.
Always give an overview of the changes you’ve made and a bit of context about what they do.
9. Infrequent and large pull requests
It’s easier to spot incorrect logic or breaking changes when the PR is small.
Frequently pushing small PRs are far more manageable.
It’s easier to spot incorrect logic or breaking changes when the PR is small.
Frequently pushing small PRs are far more manageable.
That's the end of this thread.
I simplify software development and getting into tech💡
Follow @NikkiSiapno for more free tips and free resources.
If you enjoyed this thread, don't forget to like, comment, and retweet the first tweet.
I simplify software development and getting into tech💡
Follow @NikkiSiapno for more free tips and free resources.
If you enjoyed this thread, don't forget to like, comment, and retweet the first tweet.
Loading suggestions...