Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
52 lines (37 loc) · 1.3 KB

CONTRIBUTING.md

File metadata and controls

52 lines (37 loc) · 1.3 KB

Contributing to PureMac

Thanks for your interest in contributing to PureMac.

Getting Started

  1. Fork the repo
  2. Clone your fork: git clone https://github.com/YOUR_USERNAME/PureMac.git
  3. Install prerequisites: brew install xcodegen
  4. Generate the Xcode project: xcodegen generate
  5. Open in Xcode: open PureMac.xcodeproj

Development

  • PureMac is built with SwiftUI and targets macOS 13.0+
  • Project structure is defined in project.yml (XcodeGen)
  • Run the app from Xcode with Cmd+R

Pull Requests

  • Keep PRs focused on a single change
  • Test your changes on at least macOS Ventura (13.0)
  • Follow existing code style
  • Update the README if your change affects user-facing behavior

What to Contribute

  • Bug fixes
  • New cleaning categories
  • Performance improvements
  • UI/UX enhancements
  • Localization (translations)
  • Documentation improvements

Reporting Bugs

Open an issue using the Bug Report template. Include:

  • macOS version
  • PureMac version
  • Steps to reproduce
  • Expected vs actual behavior

Feature Requests

Open an issue using the Feature Request template. Describe:

  • What you'd like to see
  • Why it would be useful
  • Any alternatives you've considered

Code of Conduct

Be respectful and constructive. We're all here to make Mac maintenance easier for everyone.