Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
60 lines (43 loc) · 1.27 KB

CONTRIBUTING.md

File metadata and controls

60 lines (43 loc) · 1.27 KB

Contributing to DevBar

Thank you for your interest in contributing to DevBar!

Getting Started

  1. Fork the repository
  2. Clone your fork locally
  3. Create a feature branch: git checkout -b feature/my-feature
  4. Make your changes
  5. Test thoroughly
  6. Commit with clear messages
  7. Push and open a Pull Request

Development Setup

# Clone
git clone https://github.com/antlss/devbar.git
cd devbar

# Generate project (if using XcodeGen)
xcodegen generate

# Open in Xcode
open DevBar.xcodeproj

Code Style

  • Follow Swift API Design Guidelines
  • Use SwiftUI for new views
  • Keep files focused and under 500 lines
  • Add comments for complex logic only

Architecture

  • Models: Data structures (Codable, Identifiable)
  • Views: SwiftUI views organized by feature
  • Services: Stateless business logic (Singleton pattern)
  • AppState: Centralized @MainActor state management

Pull Request Guidelines

  • One feature/fix per PR
  • Include description of changes
  • Update CHANGELOG.md for user-facing changes
  • Ensure build succeeds

Reporting Issues

Include:

  • macOS version
  • Steps to reproduce
  • Expected vs actual behavior
  • Console logs if applicable

License

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