Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
48 lines (31 loc) · 1.5 KB

CONTRIBUTING.md

File metadata and controls

48 lines (31 loc) · 1.5 KB

Contributing to DualClip

Thank you for your interest in contributing! Here's how you can help.

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/<your-username>/DualClip.git
  3. Create a branch: git checkout -b feature/your-feature
  4. Open Package.swift in Xcode or build with swift build

Development Requirements

  • macOS 13.0+
  • Xcode 15+ or Swift 5.9+ Command Line Tools
  • Accessibility permission (for testing keystroke simulation)

Making Changes

  1. Open an issue first to discuss what you'd like to change
  2. Keep changes focused — one feature or fix per PR
  3. Follow existing code style and conventions
  4. Test your changes locally before submitting

Pull Request Process

  1. Update documentation if your change affects user-facing behavior
  2. Ensure the project builds in both Debug and Release configurations
  3. Write a clear PR description explaining what changed and why
  4. Link the related issue in your PR description

Code Style

  • Follow existing Swift conventions in the codebase
  • Use meaningful variable and function names
  • Keep functions small and focused

Reporting Bugs

Use the Bug Report issue template.

Suggesting Features

Use the Feature Request issue template.

License

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