This is my first personal website, built from scratch.
It's currently in development and I'm teaching myself as I write its code. I will be updating and improving it over time.
Feel free to explore and provide feedback through the contacts in the header.
Thank you for visiting!
<type>/<short-description>Allowed branch types
| Type | When to use |
|---|---|
feature |
New feature |
bugfix |
Non-critical bug fix |
hotfix |
Urgent critical fix |
test |
Experimental/test code |
docs |
Documentation updates |
Examples
feature/user-authenticationbugfix/login-errorhotfix/payment-timeouttest/new-database-driverdocs/update-api-reference
General Guidelines
- ✅ Use lowercase and kebab-case (
-) - ✅ Be descriptive but concise
- ✅ Optionally include ticket IDs:
feature/PROJ-123-add-login
<type>(<scope>): <subject>
<body>Header (mandatory)
type— what you didscope— (optional) area/modulesubject— short imperative sentence, no period
Example
feat(auth): add JWT-based authentication
Body (optional)
- Use for non-trivial changes
- Add context, reasoning, or implementation details
Allowed type values
| Type | Description |
|---|---|
feat |
New feature |
fix |
Bug fix |
refactor |
Code improvement |
test |
Add/update tests |
docs |
Documentation |
chore |
Maintenance tasks |
style |
Formatting |
perf |
Performance |
ci |
CI/CD changes |
Examples
# Good
fix(login): prevent crash on empty password
# Good
docs(readme): update setup instructions
# Bad!
fixed bug
changesPR titles follow the same structure as commit headers:
<type>(<scope>): <subject>
Examples
feat(auth): implement JWT-based authenticationfix(login): handle empty passworddocs(api): update endpoint documentation
Tips
- ✅ Use imperative mood
- ✅ Match the
typewith commit types - 🚫 Avoid vague titles like:
stuff,update,fixes
| Convention | Title/Message Example |
|---|---|
| Branch | feature/user-authentication |
| Commit | feat(auth): add JWT-based authentication |
| PR | feat(auth): implement JWT-based authentication |