ReVanced-Mirror
/
revanced-documentation
mirror of https://github.com/revanced/revanced-documentation.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: use better wording

This commit is contained in:
oSumAtrIX 2023-08-04 16:44:17 +02:00 committed by GitHub
parent 3a46d313e3
commit 398222c9ea
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/revanced-development/1_setup_development_environment.md
View File

@ -78,7 +78,7 @@ done
</component>
```
> **Note**: The builds of the `revanced-patches` and `revanced-integrations` change. **Do not forget to update them as well in the run configuration program arguments.**
> **Note**: The build file names of `revanced-patches` and `revanced-integrations` change. **Do not forget to update them in the run configuration program arguments.**
## 4. ⚙️ Setup Android Studio
@ -87,21 +87,21 @@ done
## 5. ⚠️ Troubleshoot your development environment
To confirm your development environment works as intended, set a breakpoint in any patch from the `revanced-patches` project in IntelliJ IDEA. Run the build configuration for `revanced-cli` and confirm, that your IDE reaches and breaks at the breakpoint. Continue and let ReVanced CLI exit.
To confirm your development environment works as intended, set a breakpoint in any patch from the `revanced-patches` project in IntelliJ IDEA. Run the build configuration for `revanced-cli` and confirm that your IDE reaches and breaks at the breakpoint. Continue and let ReVanced CLI exit.
- If ReVanced CLI output is unexpected, confirm if you supplied the correct program arguments by following [💻 ReVanced CLI](/docs/revanced-development).
- If the breakpoint was not hit, confirm, that you correctly added the necessary projects as modules to the `revanced-cli` project
- If the breakpoint was not hit, confirm that you correctly added the necessary projects as modules to the `revanced-cli` project
## ❗ Afterword
Couple things should be considered with the development environment for ReVanced:
A couple of things should be considered with the development environment for ReVanced:
- Follow [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/)
- Pull new commits from remote to keep your branch up to date
- Keep your Run/Debug configuration up to date. Make sure, you use the correct paths in your program argument after you pull new commits. If you forget to do this, you might end up debugging for hours until realising, you supply the wrong paths to ReVanced CLI
- Keep your Run/Debug configuration up to date. Ensure you use the correct paths in your program argument after pulling new commits. If you forget to do this, you might end up debugging for hours until realising, you supply the wrong paths to ReVanced CLI
- Use development branches and always branch off and PR to `dev` branches