Development happens on the dev branch, which is merged onto master when ready to be published on the stores. To contribute to the project, open an issue or a discussion to talk about it with the maintainers.
This section guides you through submitting a bug report for Unchained. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.
Before creating bug reports, please check this list, as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible. Fill out the required template, the information it asks for helps us resolve issues faster.
Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
This section guides you through submitting an enhancement suggestion for Unchained, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion and find related suggestions.
Before creating enhancement suggestions, please check this list, as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please include as many details as possible. Fill in the template, including the steps that you imagine you would take if the feature you're requesting existed.
Unsure where to begin contributing? You can start by looking through the good first issue and help-wanted issues. If you don't know how to code in Kotlin for Android, you can still fix or write a new translation, or make the README.md or any other .md file better.
Unchained is developed on Android Studio, installed and kept up-to-date with Jetbrains Toolbox.
It should work "out of the box".
Some basic git options are explained here. My suggestion is to use Github Desktop (Linux fork).
Fork this repository, change the branch to dev and create a new branch from that with a meaningful name like "fix-dns-https". After having written your code, you can open a PR to get it merged with this repository.
This is a pretty clear guide with some pics but there are many other, like this.
The important part to keep in mind is that after forking and cloning it on your pc you need to switch the dev branch before creating a new branch:
git branch -awill show you the branchesgit checkout devwill switch todev
Before opening a PR check the code style with gradlew ktLintCheck. You may get some fixes suggested, but follow them only if they are about the code you wrote.