Update building.md with updated instructions, point README to building.md #4004
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
tomduncalf
force-pushed
the
td/update-setup-notes
branch
3 times, most recently
from
537cac8 to
3f2613d
Compare
tomduncalf
force-pushed
the
td/update-setup-notes
branch
from
3f2613d to
61f06ae
Compare
tomduncalf
changed the title
kraenhansen
reviewed
Oct 7, 2021
tomduncalf
force-pushed
the
td/update-setup-notes
branch
from
e341f2d to
eada617
Compare
kneth
approved these changes
Oct 7, 2021
takameyer
reviewed
Oct 7, 2021
|
|
||
| This is one suggested workflow for testing your local changes to Realm JS against two sample apps, making use of a script to automatically copy any changes from the `realm-js` project into the two sample projects. | ||
|
|
||
| ## Sample projects for testing changes |
There was a problem hiding this comment.
I think we could highlight our React Native templates in here.
npx react-native init TsExample --template react-native-template-realm-ts
#or
npx react-native init JsExample --template react-native-template-realm-js
There was a problem hiding this comment.
I wonder if this is the right place for highlighting them, given that this document is very specific to this flow with the watch script. Perhaps we could mention them in README.md more generally, and then a future enhancement is to rewrite the guide on development workflow, what do you think?
There was a problem hiding this comment.
How about this change to the README? 02ad469
tomduncalf
force-pushed
the
td/update-setup-notes
branch
from
cc2afe0 to
dac007d
Compare
tomduncalf
force-pushed
the
td/update-setup-notes
branch
from
22a1d97 to
02ad469
Compare
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
What, How & Why?
The existing instructions on how to setup and build the project are out of date, and are somewhat duplicated between
README.mdandbuilding.md, each with slightly different methods of doing things.This PR moves all the instructions into
building.mdand points to that from the README, and updates the instructions to reflect changes in the way the app should now be built – e.g. using the scripts rather than invoking Gradle directly, some homebrew related changes as packages have moved, etc. The instructions have also been tidied up a bit so they are in a logical order.This should ensure that new contributors have a smoother onboarding experience.
Note to reviewers: reading through the complete, rendered
building.mdusing "View File" is probably easier than comparing the diffs!☑️ ToDos
Compatibilitylabel is updated or copied from previous entryBreakinglabel has been applied or is not necessary