Uh oh!
There was an error while loading. Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork 6.3k
Update the contributing section docs#3221
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Uh oh!
There was an error while loading. Please reload this page.
Merged
Changes from all commits
Commits
Show all changes
26 commits
Select commit
Hold shift + click to select a range
daa7788
update to match the fact that for NDK we now use the side-by-side ver…
kelset 37e329c
formatting
kelset b94dc6c
update the E2E section
kelset c1fab1a
remove references to AppVeyor since it's not there anymore
kelset d29d6ab
update dependencies table
kelset f2b2498
no need to have the names there
kelset 2c9b9c4
formatting
kelset 43e0cf5
reworking the testing doc
kelset e71081b
rework minor candidate page
kelset 129b833
slight change in default text
kelset 24d7576
update the doc for RC patches
kelset 241acd3
set in the correct/logical order
kelset 58d5aab
work on the documentation for releasing the stable minor .0
kelset 0913b60
tweak the document for releasing a patch of a minor
kelset 672c792
a few more tweaks
kelset 7d09071
Update website/contributing/how-to-build-from-source.md
kelset 1491600
fix alex
kelset aafc380
Merge branch 'fix-contributing-docs' of github.com:kelset/react-nativ…
kelset 1cd15d2
Update website/contributing/release-testing.md
kelset 3f73728
Update website/contributing/release-stable-minor.md
kelset 7525fcd
Update website/contributing/release-stable-minor.md
kelset 9ccbed7
Update website/contributing/release-stable-minor.md
kelset b9a990b
Update website/contributing/release-branch-cut-and-rc0.md
kelset a995faf
Update website/contributing/how-to-run-and-write-tests.md
kelset 77eaa50
Update website/contributing/how-to-run-and-write-tests.md
kelset 0fbdc95
add redirect
kelset File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading. Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading. Please reload this page.
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -12,8 +12,8 @@ Assuming you have the Android SDK installed, run `android` to open the Android S | ||
| Make sure you have the following installed: | ||
| 1. Android SDK version 30 (`compileSdkVersion` in [`build.gradle`](https://github.com/facebook/react-native/blob/main/ReactAndroid/build.gradle)). | ||
| 2. Android NDK 21.4.7075529 (from in [`gradle.properties`](https://github.com/facebook/react-native/blob/b1120c6a6513ec24568abc6bbe60dd57ef1dec96/gradle.properties#L7), download links and installation instructions below). | ||
| 1. Android SDK (find the specific version in the `compileSdkVersion` in [`build.gradle`](https://github.com/facebook/react-native/blob/main/ReactAndroid/build.gradle#L253)). | ||
Simek marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. | ||
| 2. Android NDK | ||
| #### Point Gradle to your Android SDK | ||
| @@ -45,13 +45,7 @@ ndk.dir=/Users/your_unix_name/android-ndk/android-ndk-r20b | ||
| #### Download links for Android NDK | ||
| 1. [macOS (64-bit)](https://dl.google.com/android/repository/android-ndk-r20b-darwin-x86_64.zip) | ||
| 2. [Linux (64-bit)](https://dl.google.com/android/repository/android-ndk-r20b-linux-x86_64.zip) | ||
| 3. [Windows (64-bit)](https://dl.google.com/android/repository/android-ndk-r20b-windows-x86_64.zip) | ||
| 4. [Windows (32-bit)](https://dl.google.com/android/repository/android-ndk-r20b-windows-x86.zip) | ||
| You can find further instructions on the [official page](https://developer.android.com/ndk/index.html). | ||
| Or follow instructions to [download appropriate NDK from SDK manager](https://developer.android.com/studio/projects/install-ndk#specific-version). | ||
| You can find the instructions to install the NDK on the [official Android NDK website](https://developer.android.com/studio/projects/install-ndk). | ||
| ### Building the source | ||
| @@ -149,9 +143,9 @@ You should be able to use the _Run_ button to run your app on a device. Android | ||
| ### Additional notes | ||
| Building from source can take a long time, especially for the first build, as it needs to download ~200 MB of artifacts and compile the native code. | ||
| Building from source can take a long time, especially for the first build, as it needs to download ~200 MB of artifacts and compile the native code. | ||
| Every time you update the `react-native` version from your repo, the build directory may get deleted, and all the files are re-downloaded. | ||
| Every time you update the `react-native` version from your repo, the build directory may get deleted, and all the files are re-downloaded. | ||
| To avoid this, you might want to change your build directory path by editing the `~/.gradle/init.gradle` file: | ||
| ```groovy | ||
| @@ -192,7 +186,7 @@ Install it in your app project package.json. | ||
| ## Rationale | ||
| The recommended approach to working with React Native is to always update to the latest version. No support is provided on older versions and if you run into issues the contributors will always ask you to upgrade to the latest version before even looking at your particular issue. | ||
| The recommended approach to working with React Native is to always update to the latest version. No support is provided on older versions and if you run into issues the contributors will always ask you to upgrade to the latest version before even looking at your particular issue. | ||
| Sometimes, though, you are temporarily stuck on an older React Native version, but you require some changes from newer versions urgently (bugfixes) without having to do a full upgrade right now. This situation should be short lived by definition and once you have the time, the real solution is to upgrade to the latest version. | ||
| @@ -226,9 +220,9 @@ Upload the binaries from the `android` folder to maven and point your Android ap | ||
| Instead of uploading to Maven/Nexus, you can add the binaries built in the previous steps to git, by changing the .gitignore and committing the binaries to your forked branch. This allows you to make your fork into a functioning git dependency for React Native app projects. | ||
| If you have changes that you want to actually merge to React Native, make them on another branch first and open a PR. | ||
| If you have changes that you want to actually merge to React Native, make them on another branch first and open a PR. | ||
| To start making your dependency branch, make sure you are on a `release/my-forked-release` branch, then merge any commits that you need from yourself or others into this branch. | ||
| To start making your dependency branch, make sure you are on a `release/my-forked-release` branch, then merge any commits that you need from yourself or others into this branch. | ||
| :::warning | ||
| This release branch should never be merged into any other branch. | ||
This file contains hidden or 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
This file contains hidden or 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
Oops, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
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.
Uh oh!
There was an error while loading. Please reload this page.