Git Best Practices

Use .gitignore

Make small, frequent commits to capture your progress. This makes it easier to track changes and find bugs.

Example git add .

Use descriptive messages that explain why a change was made, not just what changed. Good commit messages help you and your team understand the history of the project.

Say what and why, not just "Update" or "Fix".

For example, "Add login validation" instead of "Added login validation".

Example git commit -m "Fix bug in user login validation"

Create branches for features, fixes, and experiments to keep your main branch stable. This way, you can work on new ideas without affecting the main codebase.

Example git checkout -b feature/login-form

Always git pull before pushing. This updates your local branch with changes from others, helps you avoid conflicts, and ensures your push will succeed.

Pulling first lets you fix any issues locally.

Example git pull origin main git push origin main

Use git status and git diff to review your changes before you commit. This helps you catch mistakes early.

Avoid adding large files or unnecessary dependencies. This keeps your repository fast and easy to clone.

For large files (like videos or datasets), use

(Large File Storage) instead of adding them directly to your repo. Use .gitignore Exclude files that shouldn't be tracked (like build artifacts, log files, or secrets) by adding them to a.gitignore file.

Example: .gitignore # .gitignore node_modules/ *.log.env

Use tags to mark release points (like v1.0 ) so you can easily find and reference important versions. This helps you keep track of your project's history and make it easier to roll back to previous versions if needed.

Example git tag v1.0 git push origin v1.0

Good Git habits make it easier for your team (and your future self) to understand and build on your work.