Skip to content

Latest commit

 

History

History
32 lines (23 loc) · 978 Bytes

File metadata and controls

32 lines (23 loc) · 978 Bytes

Contributing to OpenGlass 🕶️

Thanks for your interest in contributing!

Getting Started

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/my-feature)
  3. Make your changes
  4. Run any tests and ensure the project builds cleanly in Xcode
  5. Commit with a clear message (git commit -m "Add: brief description")
  6. Push to your fork and open a Pull Request

Guidelines

  • Swift style: Follow Swift API Design Guidelines
  • Architecture: MVVM pattern — keep views thin, logic in ViewModels/Services
  • Commits: Use conventional commit messages (Add, Fix, Update, Remove)
  • Documentation: Update relevant docs if you change behaviour
  • Modes: Adding a new mode? See docs/MODES.md for the protocol

Reporting Issues

Open an issue with:

  • What you expected
  • What happened
  • Steps to reproduce
  • Device/iOS version

Code of Conduct

Be kind. Be constructive. We're all here to build something cool.