Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
37 lines (25 loc) · 1.39 KB

CONTRIBUTING.md

File metadata and controls

37 lines (25 loc) · 1.39 KB
Raw

Contributing to Browser

Thank you for contributing! Please check existing issues and pull requests before creating new ones.

Setup

Browser requires macOS 26 or later, Xcode 26 or later, and XcodeGen.

xcodegen generate
xcodebuild -project Browser.xcodeproj -scheme Browser -configuration Debug -derivedDataPath DerivedData build CODE_SIGNING_ALLOWED=NO
open DerivedData/Build/Products/Debug/Browser.app

Run the tests with:

xcodebuild -project Browser.xcodeproj -scheme Browser -derivedDataPath DerivedData test CODE_SIGNING_ALLOWED=NO

Before Submitting

  1. The app builds and the tests pass
  2. Rebase on main: git rebase origin/main
  3. Squash commits into logical units
  4. Update the README if behavior or shortcuts change
  5. Read and agree to the Contributor License Agreement by checking the box in the pull request

Contributor License Agreement

Browser is licensed under the AGPL-3.0, and Athas also distributes it under other terms, such as through the Mac App Store. The Contributor License Agreement gives Athas the rights to include your contribution in both. You keep the copyright in your work. Pull requests without the agreement checked can't be merged.

Guidelines

  • Follow the existing code style
  • Use descriptive commit messages (e.g., "Add tab shortcuts")
  • One logical change per commit