Conventional: Comments

⚓ About

❌ Bad review comment

✅ Good review comment

🏆 Better review comment

🚧 Conventional comment format

<label> [decorations]: <subject>[discussion]

🔖 Labels


🥇 Best Practices

  1. Leave actionable comments
  2. Combine similar comments
  3. Replace “you” with “we

📑 Saved replies Github

💻 Conventional Comments Buttons Extension

Conventional comments extension

📑 Conclusion

  1. The intention of our comment is clear
  2. The separation between the topic of the comment and the example and/or reasoning of the comment is very clear and straight
  3. The author knows what they should prioritize because our comments are well-labeled

🔗 References

Frontend Software Engineer@Instabug

Love podcasts or audiobooks? Learn on the go with our new app.

Recommended from Medium

Authenticating HTTP Requests in Modern Web Apps

How I created my first GUI using Python

Implementing Agile Practices

My experience at LGM-VIP 2021 web internship

Ansible :

Practical GIT Using CLI

“Digisaur Dwellers” — a community to fit in.

Mac How To Put Download Folder In Dock

Get the Medium app

A button that says 'Download on the App Store', and if clicked it will lead you to the iOS App store
A button that says 'Get it on, Google Play', and if clicked it will lead you to the Google Play store
Abdallah Hemdan

Abdallah Hemdan

Frontend Software Engineer@Instabug

More from Medium

Generic Type Inference through Function Arguments in TypeScript

Truncate a String using substr() method.