Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
31 lines (21 loc) · 985 Bytes

CONTRIBUTING.md

File metadata and controls

31 lines (21 loc) · 985 Bytes

Contributing to LuxShot

Thank you for considering contributing to LuxShot! We welcome contributions from the community.

Getting Started

  1. Fork the repository: Click the "Fork" button on the top right of the repository page.
  2. Clone your fork: git clone https://github.com/YOUR-USERNAME/LuxShot.git
  3. Open in Xcode: Open LuxShot.xcodeproj.

Development Guidelines

  • Swift Style: Follow the standard Swift style guide.
  • Commit Messages: Write clear, concise commit messages.
  • Testing: Manual testing is currently used. Ensure ⌘⇧E capture works, and history/OCR results are correct.

Reporting Bugs

Please report bugs using the GitHub Issue Tracker. Include:

  • A clear description of the issue.
  • Steps to reproduce.
  • Your macOS version.

Pull Requests

  1. Create a new branch: git checkout -b my-new-feature
  2. Commit your changes.
  3. Push to the branch: git push origin my-new-feature
  4. Submit a pull request.

Thank you!