📚 Developer Notes

A personal collection of development notes, best practices, workflows, coding conventions, and reference materials that I use across my software projects.

This repository serves as my engineering handbook, helping me maintain consistency, improve code quality, and document lessons learned throughout my journey as a software developer and IT professional.

---

📑 Table of Contents

• Conventional Commits
• Git Workflow
• Branch Naming Conventions
• Pull Request Checklist
• Coding Standards
• Useful Commands
• Resources

---

✨ Conventional Commits

I follow the Conventional Commits specification to create a clean and meaningful Git history.

Commit Format

<type>(optional scope): <description>

Examples

feat(finance): implement recurring transactions

fix(contact): correct email validation

docs(profile): redesign GitHub profile README

refactor(auth): simplify authentication service

perf(map): optimize map marker rendering

test(auth): add login unit tests

chore: update Flutter dependencies

---

📋 Commit Types

Type	Purpose	Example
feat	Introduce a new feature	feat(auth): implement login
fix	Fix a bug	fix(ui): resolve overflow on mobile
docs	Documentation changes only	docs: update README
style	Formatting, whitespace, linting (no code logic changes)	style: format CSS files
refactor	Improve existing code without changing behavior	refactor(api): simplify service layer
perf	Improve performance	perf(images): optimize lazy loading
test	Add or modify tests	test(auth): add login unit tests
build	Build system or dependency changes	build: update Gradle configuration
ci	Continuous Integration changes	ci: update GitHub Actions workflow
chore	Maintenance tasks	chore: update dependencies
revert	Revert a previous commit	revert: revert login redesign

---

📝 Writing Good Commit Messages

✅ Good

feat(finance): add recurring transaction support

fix(profile): correct avatar upload issue

docs(api): add authentication guide

refactor(database): simplify repository pattern

perf(home): reduce initial loading time

chore: upgrade Flutter SDK

❌ Avoid

update

fix

changes

asd

test

haha

new

final

final-final

updated code

Commit messages should explain what changed, not simply that something changed.

---

🌳 Git Workflow

Feature Development

main
 │
 ├── feature/authentication
 ├── feature/contact-form
 ├── feature/dark-theme
 └── feature/settings-page

Typical workflow:

git checkout main
git pull

git checkout -b feature/new-feature

# Make changes...

git add .
git commit -m "feat(feature): add new functionality"

git push origin feature/new-feature

---

🌿 Branch Naming Convention

Prefix	Purpose
feature/	New functionality
bugfix/	Bug fixes
hotfix/	Critical production fixes
refactor/	Code restructuring
docs/	Documentation
release/	Release preparation

Examples:

feature/authentication

feature/flutter-finance

bugfix/login-validation

refactor/navigation

docs/readme

release/v1.0.0

---

✅ Pull Request Checklist

Before opening a Pull Request:

• Code builds successfully
• No compiler warnings
• No unnecessary commented code
• Documentation updated
• Screenshots updated (if UI changes)
• Responsive layout verified
• Dark mode verified
• Accessibility checked
• Meaningful commit messages
• Code reviewed before merging

---

💡 Coding Principles

• Write readable code before clever code.
• Prefer composition over duplication.
• Keep functions focused on a single responsibility.
• Name variables clearly.
• Comment why, not what.
• Refactor continuously.
• Build for maintainability.

---

📖 Documentation Standards

Each project should include:

• Project Overview
• Features
• Screenshots
• Tech Stack
• Installation Guide
• Folder Structure
• Architecture
• Roadmap
• License

---

🚀 Repository Checklist

Before making a repository public:

• README completed
• Screenshots added
• LICENSE included
• .gitignore configured
• Environment variables removed
• Secrets excluded
• Project builds successfully
• Live Demo added (if applicable)

---

📚 Resources

Git

• https://git-scm.com/docs
• https://www.conventionalcommits.org/

Flutter

• https://docs.flutter.dev/

Dart

• https://dart.dev/

Firebase

• https://firebase.google.com/docs

Markdown

• https://www.markdownguide.org/

---

📌 Notes

This repository is continuously updated as I learn new technologies, discover better development practices, and refine my engineering workflow.

"Write code as if the next person maintaining it is your future self."