Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
70 lines (51 loc) · 1.7 KB

CONTRIBUTING.md

File metadata and controls

70 lines (51 loc) · 1.7 KB

Contributing to alfred-timein

Thank you for your interest in contributing to alfred-timein!

Commit Message Format

This project uses Conventional Commits for automated changelog generation.

Format

<type>: <description>

Types

  • feat: A new feature
  • fix: A bug fix
  • refactor: Code change that neither fixes a bug nor adds a feature
  • chore: Changes to build process, auxiliary tools, or maintenance
  • ci: Changes to CI/CD configuration
  • docs: Documentation changes
  • test: Adding or updating tests

Examples

feat: add timezone lookup caching for improved performance
fix: resolve crash when geocoding returns no results
refactor: extract timezone finder interface for better testability
chore: update dependencies to latest versions
ci: add automated testing for pull requests
docs: update README with installation instructions
test: add unit tests for cache functionality

Development Workflow

  1. Create feature branch from dev
  2. Make changes with conventional commit messages
  3. Test locally with make test-all
  4. Submit PR to dev branch
  5. Automated testing runs on all PRs
  6. Beta releases are created automatically from dev
  7. Stable releases are created when dev is merged to main

Testing

# Run all tests
make test-all

# Run unit tests only
make test

# Run BDD tests only
make test-bdd

# Build binaries
make build

# Build Alfred workflow
make alfredworkflow

Release Process

  • Beta releases: Automatic on dev branch pushes
  • Stable releases: Manual tag creation on main branch
  • Changelogs: Generated automatically from commit messages