Skip to content
This repository has been archived by the owner on Dec 15, 2020. It is now read-only.

Latest commit

 

History

History
21 lines (11 loc) · 2.05 KB

CHANGE_LIMITATIONS.md

File metadata and controls

21 lines (11 loc) · 2.05 KB

What changes we can't accept

While we wish we could accept all changes (especially changes that make the organization or readability of the project better), we can't due to technical limitations 😢.

What is up with this weird module map or strange import statement 🤷‍♂️?

We host our source code inside Google and treat that as the “source of truth”. The internal build toolchain and dependency manager are not CocoaPods. In order to be able to work with both internal and external tooling, we’ve had to make some concessions with how the project is configured. There are a number of considerations you must make if you’re thinking about changing things that look non-standard.

Module maps and import statements

We use custom module maps that link directly to various dependencies like SSOAuth. We can’t modify these as our internal dependency management tool has some requirements that necessitate the current import format. You can see that come into play where imports are prefixed with things like “googlemac_iPhone”. Sadly, we must leave these in.

Updating Swift

We want to be running the latest Swift 🏃‍♀️ as much as anybody. At this time we can’t accept Swift version update PRs. Our internal source of truth must be updated first. Because the internal source of truth has more code than the open source project, we’ll have to do the migration, and test it internally to make sure all of our tooling works—inside and outside of Google.

Podfile updates

Adding new pods isn’t out of the question, but please be mindful as we only support Apache 2.0 and MIT licensed software.

It is unlikely we'd be able to approve the removal or update of existing pods. We have more internal requirements that must be satisfied so we limit podfile updates to new features, bug fixes, and security updates that impact us.