Linear-Guide

The What and How of Good GitHub Practices

This documentation contains the common good GitHub practices.

Table of Contents

1. Writing a good commit message.

Writing a good commit message

Every time when we create a new commit, we need to input the commit title/message. Here is the list of conventional commit messages type:

• feat: Adding a new feature
• fix: Fixing code/bug
• improvement: Improving or updating a section of the code
• refactor: Refactoring a section of the code
• style: Changes to styling of the website
• chore: Code maintenance/miscellaneous tasks
• test: Testing purpose
• docs: Documentation

References

Ayodeji, B. (2019, Nov 28). How to Write Good Commit Messages: A Practical Git Guide. https://www.freecodecamp.org/news/writing-good-commit-messages-a-practical-guide/.