Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
51 lines (34 loc) · 1.39 KB

CONTRIBUTING.md

File metadata and controls

51 lines (34 loc) · 1.39 KB
Raw

Contributing to audio-control

Thanks for taking the time to contribute. Here's everything you need to get started.

Ways to contribute

  • Report a bug — open an issue using the Bug Report template
  • Suggest a feature — open an issue using the Feature Request template
  • Fix a bug — pick any open issue labeled bug and submit a pull request
  • Improve docs — typos, clarity, missing steps in the README are all welcome

Before you start

For anything beyond a small fix, please open an issue first to discuss the change. This avoids situations where you spend time on something that won't be merged.

Setup

git clone https://github.com/YOUR_USERNAME/audio-control.git
cd audio-control
open audio-control.xcodeproj

Requires Xcode 15 or later and macOS 13 Ventura or later.

Pull request checklist

  • Code builds without warnings
  • Existing functionality is not broken
  • New functionality has a brief description in the PR
  • CHANGELOG.md is updated under [Unreleased]

Code style

  • Swift standard conventions
  • Descriptive variable and function names
  • Comments for non-obvious logic only

Commit messages

Use the imperative mood in the subject line:

Add support for virtual desktops
Fix layout not restoring on second monitor
Update README install instructions

Questions

Open an issue and tag it question — happy to help.