Skip to content

Commit 294d7ce

Browse files
authored
Add notice about setting the default remote when running init scripts on a fork (#923)
1 parent 382e163 commit 294d7ce

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ For big feature it's advised to raise an issue to discuss it first.
55

66
## Getting started
77

8-
### Dependencies
8+
### Prerequisites
99

1010
- [GitHub CLI](https://cli.github.com/)
1111

@@ -22,6 +22,8 @@ To be able to build for Android, make sure to configure the SDK & NDK according
2222

2323
> Currently this method is available only for C++ UE projects! Blueprint project can be converted to a C++ one simply by adding an empty class via Editor.
2424
25+
> When working with a `sentry-unreal` fork, run `gh repo set-default` to select the default remote repository used for GitHub API queries (required for pulling plugin dependencies from CI). If you don't plan to configure the CI pipeline for your fork, it's recommended to set `getsentry/sentry-unreal` as the default remote.
26+
2527
To get started, we recommend running the init script:
2628

2729
* `./scripts/init.sh` on macOS/Linux

0 commit comments

Comments
 (0)