docs: Add more detail and improve readability. #328
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add more detail to the developer guide for new contributors.
trueskawka
force-pushed
the
developer-docs
branch
from
1e248c0
to
6f1f461
Compare
Add more whitespace to make README.md more readable.
trueskawka
force-pushed
the
developer-docs
branch
from
6f1f461
to
f37c9eb
Compare
neerajwahi
reviewed
Feb 14, 2017
|
|
||
| ## Running on an iOS device | ||
| 1. [Set up the dev environment](#setting-up-a-dev-environment) | ||
| 2. Connect your iOS device | ||
| 3. Within the repo, `$ open ios/ZulipMobile.xcodeproj/` to open Xcode | ||
| 4. Select your device as the `build target` (from [this guide](https://facebook.github.io/react-native/docs/running-on-device-ios.html)) | ||
| 5. Hit the `build and run` button | ||
| 4. Change BundleIdentifier for both ZulipMobile and ZulipMobileTests to a |
There was a problem hiding this comment.
This shouldn't be necessary anymore. @trueskawka do you still need to do this?
There was a problem hiding this comment.
I get this when I don't change the string, on the latest master:
| If it's your first time installing an app on an iOS device, you need to | ||
| obtain Apple Developer credentials that will allow you to sign the app. | ||
| Register at https://developer.apple.com. Then use your Apple ID in Xcode | ||
| and choose it as your `Signing > Team` for both ZulipMobile and ZulipMobileTests. |
There was a problem hiding this comment.
Maybe we should add something about not committing these changes to project.pbxproj to diffs?
There was a problem hiding this comment.
yeah, making it more explicit will be useful :)
chrisbobbe
added a commit
to chrisbobbe/zulip-mobile
that referenced
this pull request
Sep 1, 2021
Just while we wait for the code in this package to be error-free when exact_by_default is enabled [1]. We plan to enable it for the RN v0.64 upgrade (zulip#4426). The PR is react-native-cameraroll/react-native-cameraroll#328. It's very possible that some of those object types would be better as exact instead of inexact. But: 1. Just getting the library to pass the implicit-inexact-object lint is enough to unblock switching on exact_by_default (for us and for other projects that want to do that too). 2. I guess we could go through and decide what should stay inexact and what should be made exact. But then each of those choices would have to be approved, and some of them would probably be breaking changes that we'd need to write changelog entries for. (Not ones that would affect an app at runtime -- but still, apps that use Flow would predictably have to change their code to adapt.) [1] https://medium.com/flow-type/how-to-upgrade-to-exact-by-default-object-type-syntax-7aa44b4d08ab
gnprice
pushed a commit
to chrisbobbe/zulip-mobile
that referenced
this pull request
Sep 1, 2021
Just while we wait for the code in this package to be error-free when exact_by_default is enabled [1]. We plan to enable it for the RN v0.64 upgrade (zulip#4426). The PR is react-native-cameraroll/react-native-cameraroll#328. It's very possible that some of those object types would be better as exact instead of inexact. But: 1. Just getting the library to pass the implicit-inexact-object lint is enough to unblock switching on exact_by_default (for us and for other projects that want to do that too). 2. I guess we could go through and decide what should stay inexact and what should be made exact. But then each of those choices would have to be approved, and some of them would probably be breaking changes that we'd need to write changelog entries for. (Not ones that would affect an app at runtime -- but still, apps that use Flow would predictably have to change their code to adapt.) So instead, the PR just makes all the implicit inexact object types explicitly inexact. It's based directly on v4.0.4, the version we've been using, so it doesn't pull in any other changes. [1] https://medium.com/flow-type/how-to-upgrade-to-exact-by-default-object-type-syntax-7aa44b4d08ab
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added more detail to
docs/developer-guide.md, based on my experience with installing the app on an iOS device for the first time. Not sure if we should make it more explicit.Improved current docs readability - shorter line lengths (mostly for
catting / reading GH on a mobile device), more whitespace.