Wikipedia

Note: Your Xcode version must be at least 16.0. In the directory, run ./scripts/setup . Note: going to scripts directory and running setup will not work due to relative paths. Running scripts/setup will setup your computer to build and run the app. The script assumes you have Xcode installed already. It will install homebrew, SwiftLint, and ClangFormat. It will also create a pre-commit hook that uses ClangFormat for linting Objective-C code. After running scripts/setup , you should be able to open Wikipedia.xcodeproj and run the app on the iOS Simulator (using the Wikipedia scheme and target). If you encounter any issues, please don't hesitate to let us know via a bug report. Xcode - The easiest way to get Xcode is from the App Store, but you can also download it from developer.apple.com if you have an Apple ID registered with an Apple Developer account. SwiftLint - We use this for linting Swift code. ClangFormat - We use this for linting Objective-C code. Coding Guidelines Objective-C - Apple's Coding Guidelines for Cocoa Swift - swift.org API Design Guidelines Formatting We use Xcode's default 4 space indentation and our .clang-format file with the pre-commit hook setup by scripts/setup . Where possible, our Swift code is automatically formatted by SwiftLint based on the rules defined in .swiftlint-autocorrect.yml . The app only writes Warning and Error messages to the console for both Debug and Release mode. If you need to log all messages temporarily during troubleshooting, update this level to DDLogLevelAll. Wikipedia - Points to production servers. Staging - Points to various staging server environments. You can adjust these environments by changing the current property of Configuration : An option of appsLabsForPCS will point to the Apps team's staging environment for page content. An option of betaCluster will point to the MediaWiki beta cluster environment for most API calls. This is meant to be a more blanket environment setting, so if this value exists it will also force the beta cluster environment for page content on the article view. This beta cluster environment is also where developers can test sandbox push notifications triggered across various wikis. This is selected by default. WMF - Bundles up the app logic shared between the main app and the extensions (widgets, notifications). Update Localizations - Covered in the localization document. Update Languages - For adding new Wikipedia languages or updating language configurations. Covered in the languages document. {{name}}Widget, {{name}}Notification, {{name}}Stickers - Extensions for widgets, notifications, and stickers. Web Development The article view and several other components of the app rely on web components. Instructions for working on these components are covered in the web development document. Contact Us If you have any questions or comments, you can email us at ios-support[at]wikimedia dot org. We'll also gladly accept any bug reports.