Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/0xdps/default-tamer/llms.txt

Use this file to discover all available pages before exploring further.

Thank you for your interest in contributing to Default Tamer! This guide will help you get started with contributing to the project.

Code of Conduct

Be respectful, inclusive, and constructive in all interactions with the Default Tamer community.

How to Contribute

Reporting Bugs

1

Check existing issues

Search the Issues page to see if the bug has already been reported.
2

Create a new issue

If the bug hasn’t been reported, create a new issue with:
  • Clear, descriptive title
  • Steps to reproduce the behavior
  • Expected vs actual behavior
  • macOS version and Default Tamer version
  • Relevant logs or screenshots

Suggesting Features

1

Check existing requests

Review Issues to see if the feature has already been requested.
2

Submit your feature request

Create a new issue with:
  • Clear description of the feature
  • Use case and benefits
  • Potential implementation approach (optional)

Pull Request Process

1

Fork and create a branch

Fork the repository and create a feature branch:
git checkout -b feature/your-feature-name
2

Make your changes

Implement your changes following these guidelines:
  • Follow existing code style and conventions
  • Add comments for complex logic
  • Update documentation if needed
3

Test thoroughly

Before submitting:
  • Build and run the app
  • Test affected functionality
  • Verify no regressions in existing features
  • Ensure app builds without warnings
4

Commit and push

Commit your changes with clear messages:
git commit -m "Add feature: description"
git push origin feature/your-feature-name
5

Create Pull Request

Submit a pull request with:
  • Reference to related issues
  • Description of what changed and why
  • Screenshots for UI changes

Code Style Guidelines

Swift Style

  • Follow the Swift API Design Guidelines
  • Use Xcode’s default formatting (⌃I to reformat)
  • Choose clear, descriptive names for variables and functions
  • Write comments to explain “why”, not “what”

Example

// Good: Explains the reasoning
// Use enhanced detector with Apple Event support for better accuracy
let detectionResult = SourceAppDetector.shared.detectSourceAppWithConfidence(from: event)

// Avoid: States the obvious
// Get the detection result
let detectionResult = SourceAppDetector.shared.detectSourceAppWithConfidence(from: event)

Testing Checklist

Before submitting a pull request, ensure:
  • App builds without warnings
  • All existing features still work
  • New features work as expected
  • No memory leaks or crashes
  • Tested on supported macOS versions (13.0+)

Areas for Contribution

Bug Fixes

Check open issues for reported bugs that need fixing

Features

See the roadmap in README for planned features

Documentation

Improve guides, comments, and developer documentation

Testing

Add test coverage and improve reliability

UI/UX

Enhance user experience and interface design

Performance

Optimize routing logic and UI responsiveness

Getting Help

  • Open a Discussion for questions
  • Comment on relevant issues for clarification

License

By contributing, you agree that your contributions will be licensed under the MIT License.

Build docs developers (and LLMs) love