Contributing Guide

// ✅ Good: Clear, descriptive names
func GetUserByID(ctx context.Context, userID int) (*User, error) {
    // ...
}

type JobMatchResult struct {
    Score       float64
    Explanation string
}

// ❌ Bad: Unclear or abbreviated names
func GetUsr(id int) *User {}
type JMR struct {}

// UserService handles user-related operations including
// authentication, profile management, and preferences.
type UserService struct {
    repo       UserRepository
    tokenSvc   TokenService
}

// Register creates a new user account with the provided credentials.
// It returns an error if the username already exists or validation fails.
func (s *UserService) Register(ctx context.Context, username, password string) (*User, error) {
    // Implementation
}

// ✅ Good: Descriptive error messages with context
if err != nil {
    return nil, fmt.Errorf("failed to create user %s: %w", username, err)
}

// ✅ Good: Custom error types for specific cases
if errors.Is(err, ErrUserNotFound) {
    return nil, ErrInvalidCredentials
}

// ❌ Bad: Silent error swallowing
if err != nil {
    log.Println(err)
    return nil, nil
}

// ✅ Good: Single responsibility
func (s *JobService) CreateJob(ctx context.Context, job *Job) error {
    if err := s.validateJob(job); err != nil {
        return err
    }
    return s.repo.Create(ctx, job)
}

func (s *JobService) validateJob(job *Job) error {
    if job.Title == "" {
        return ErrInvalidJobTitle
    }
    return nil
}

// ❌ Bad: Function doing too much
func (s *JobService) CreateJob(ctx context.Context, job *Job) error {
    // 100+ lines of validation, transformation, and persistence
}

<!-- ✅ Good: Semantic HTML with clear structure -->
<article class="job-card">
  <header class="job-card-header">
    <h3 class="job-title">{{ .Title }}</h3>
  </header>
  <div class="job-details">
    <p>{{ .Description }}</p>
  </div>
</article>

<!-- ❌ Bad: Divs without semantic meaning -->
<div class="card">
  <div class="header">
    <div>{{ .Title }}</div>
  </div>
</div>

<!-- ✅ Good: Consistent spacing, readable classes -->
<div class="flex items-center gap-4 p-4 bg-white rounded-lg shadow">
  <img src="logo.png" alt="Company logo" class="w-12 h-12 rounded" />
  <div>
    <h3 class="text-lg font-semibold">{{ .CompanyName }}</h3>
  </div>
</div>

<!-- ❌ Bad: Inline styles, inconsistent spacing -->
<div style="display: flex; padding: 20px">
  <img src="logo.png" style="width: 50px" />
  <div style="margin-left: 10px">{{ .CompanyName }}</div>
</div>

# ✅ Good
Add job search filter by location
Fix authentication token expiry issue
Update API documentation for job endpoints
Refactor job matching algorithm

# ❌ Bad
Added job search filter
Fixes authentication bug
Updated documentation
Refactors matching algorithm

<type>: <short summary>

<detailed description if needed>

<footer with issue references>

make setup-hooks

## Description
Clear description of what this PR does and why.

## Related Issues
Closes #123
Related to #456

## Type of Change
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] Documentation update

## Testing
Describe the tests you ran and how to reproduce:
1. Test scenario 1
2. Test scenario 2

## Screenshots (if applicable)
[Add screenshots for UI changes]

## Checklist
- [ ] My code follows the style guidelines
- [ ] I have performed a self-review
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally
- [ ] Any dependent changes have been merged and published