Fetch from FoxPipe Preunified

.github/CONTRIBUTING.md

@@ -1,64 +1,77 @@
-NewPipe contribution guidelines
+FoxPipe contribution guidelines
 ===============================
 
-PLEASE READ THESE GUIDELINES CAREFULLY BEFORE ANY CONTRIBUTION!
-
 ## Crash reporting
 
-Do not report crashes in the GitHub issue tracker. NewPipe has an automated crash report system that will ask you to
-send a report via e-mail when a crash occurs. This contains all the data we need for debugging, and allows you to even
-add a comment to it. You'll see exactly what is sent, the system is 100% transparent.
+Report crashes through the automated crash report system of NewPipe.
+This way all the data needed for debugging is included in your bugreport for GitHub.
+You'll see exactly what is sent, be able to add your comments, and then send it.
 
 ## Issue reporting/feature requests
 
-* Search the [existing issues](https://github.com/TeamNewPipe/NewPipe/issues) first to make sure your issue/feature
-hasn't been reported/requested before.
-* Check whether your issue/feature is already fixed/implemented.
-* Check if the issue still exists in the latest release/beta version.
-* If you are an Android/Java developer, you are always welcome to fix an issue or implement a feature yourself. PRs welcome!
-* We use English for development. Issues in other languages will be closed and ignored.
+* **Already reported**? Browse the [existing issues](https://github.com/ShareASmile/FoxPipe/issues) to make sure your issue/feature hasn't been reported/requested.
+* **Already fixed**? Check whether your issue/feature is already fixed/implemented.
+* **Still relevant**? Check if the issue still exists in the latest release/beta version.
+* **Can you fix it**? If you are an Android/Java developer, you are always welcome to fix an issue or implement a feature yourself. PRs welcome!
+* **Is it in English**? We use English for development. Issues in other languages will be closed and ignored.
 * Please only add *one* issue at a time. Do not put multiple issues into one thread.
-* Follow the template! Issues or feature requests not matching the template might be closed.
+* **The template**: Fill it out, Follow the template! Issues or feature requests not matching the template might be closed.
 
-## Bug Fixing
-* If you want to help NewPipe to become free of bugs (this is our utopic goal for NewPipe), you can send us an email to
-<a href="mailto:[email protected]">[email protected]</a> to let us know that you intend to help. We'll send you further instructions. You may, on request,
-register at our [Sentry](https://sentry.schabi.org) instance (see section "Crash reporting" for more information).
+## Code contribution
 
-## Translation
+### Guidelines
 
-* NewPipe is translated via [Weblate](https://hosted.weblate.org/projects/newpipe/strings/). You can log in there
-with your GitHub account.
-* If the language you want to translate is not on Weblate, you can add it: see [How to add a new language](https://github.com/TeamNewPipe/NewPipe/wiki/How-to-add-a-new-language-to-NewPipe) in the wiki.
+* Stick to NewPipe's *style conventions* of [checkStyle](https://github.com/checkstyle/checkstyle) and [ktlint](https://github.com/pinterest/ktlint). They run each time you build the project.
+* Stick to [F-Droid contribution guidelines](https://f-droid.org/wiki/page/Inclusion_Policy).
+* In particular **do not bring non-free software** (e.g. binary blobs) into the project. Make sure you do not introduce any closed-source library from Google.
 
-## Code contribution
+### Before starting development
 
-* Stick to NewPipe's style conventions: follow [checkStyle](https://github.com/checkstyle/checkstyle). It will run each time you build the project.
-* Do not bring non-free software (e.g. binary blobs) into the project. Also, make sure you do not introduce Google
-  libraries.
-* Stick to [F-Droid contribution guidelines](https://f-droid.org/wiki/page/Inclusion_Policy).
-* Make changes on a separate branch with a meaningful name, not on the master neither dev branch. This is commonly known as *feature branch workflow*. You
-  may then send your changes as a pull request (PR) on GitHub.
-* When submitting changes, you confirm that your code is licensed under the terms of the
-  [GNU General Public License v3](https://www.gnu.org/licenses/gpl-3.0.html).
-* Please test (compile and run) your code before you submit changes! Ideally, provide test feedback in the PR
-  description. Untested code will **not** be merged!
+* If you want to help out with an existing bug report or feature request, **leave a comment** on that issue saying you want to try your hand at it.
+* If there is no existing issue for what you want to work on, **open a new one**  describing the changes you are planning to introduce. This gives the team and the community a chance to give **feedback** before you spend time on something that is already in development, should be done differently, or should be avoided completely.
+* Please show **intention to maintain your features** and code after you contribute a PR. Unmaintained code is a hassle for core developers. If you do not intend to maintain features you plan to contribute, please rethink your submission, or clearly state that in the PR description.
+* Create PRs that cover only **one specific issue/solution/bug**. Do not create PRs that are huge monoliths and could have been split into multiple independent contributions.
+* FoxPipe uses [NewPipeExtractor](https://github.com/TeamNewPipe/NewPipeExtractor) to fetch data from services. If you need to change something there, you must test your changes in NewPipe. Telling NewPipe to use your extractor version can be accomplished by editing the `app/build.gradle` file: the comments under the "NewPipe libraries" section of `dependencies` will help you out.
+
+### Kotlin in NewPipe
+* NewPipe will remain mostly Java for time being
+* Contributions containing a simple conversion from Java to Kotlin should be avoided. Conversions to Kotlin should only be done if Kotlin actually brings improvements like bug fixes or better performance which are not, or only with much more effort, implementable in Java. The core team sees Java as an easier to learn and generally well adopted programming language.
+
+### Creating a Pull Request (PR)
+
+* Make changes on a **separate branch** with a meaningful name, not on the _master_ branch or the _dev_ branch. This is commonly known as *feature branch workflow*. You may then send your changes as a pull request (PR) on GitHub.
+* Please **test** (compile and run) your code before submitting changes! Ideally, provide test feedback in the PR description. Untested code will **not** be merged!
+* Respond if someone requests changes or otherwise raises issues about your PRs.
 * Try to figure out yourself why builds on our CI fail.
-* Make sure your PR is up-to-date with the rest of the code. Often, a simple click on "Update branch" will do the job,
-  but if not, you are asked to rebase the dev branch manually and resolve the problems on your own. You can find help [on the wiki](https://github.com/TeamNewPipe/NewPipe/wiki/How-to-merge-a-PR). That will make the
-  maintainers' jobs way easier.
-* Please show intention to maintain your features and code after you contributed it. Unmaintained code is a hassle for
-  the core developers, and just adds work. If you do not intend to maintain features you contributed, please think again
-  about submission, or clearly state that in the description of your PR.
-* Respond yourselves if someone requests changes or otherwise raises issues about your PRs.
-* Send PR that only cover one specific issue/solution/bug. Do not send PRs that are huge and consists of multiple
-  independent solutions.
+* Make sure your PR is **up-to-date** with the rest of the code. Often, a simple click on "Update branch" will do the job, but if not, you must *rebase* your branch on the `dev` branch manually and resolve the conflicts on your own. You can find help [on the wiki](https://github.com/TeamNewPipe/NewPipe/wiki/How-to-merge-a-PR). Doing this makes the maintainers' job way easier.
+
+## IDE setup & building the app
+
+### Basic setup
+
+NewPipe is developed using [Android Studio](https://developer.android.com/studio/). Learn more about how to install it and how it works in the [official documentation](https://developer.android.com/studio/intro). In particular, make sure you have accepted Android Studio's SDK licences. Once Android Studio is ready, setting up the NewPipe project is fairly simple:
+- Clone the NewPipe repository with `git clone https://github.com/SharASmile/FoxPipe.git` (or use the link from your own fork, if you want to open a PR).
+- Open the folder you just cloned with Android Studio.
+- Build and run it just like you would do with any other app, with the green triangle in the top bar.
+
+You may find [SonarLint](https://www.sonarlint.org/intellij)'s **inspections** useful in helping you to write good code and prevent bugs.
+
+### checkStyle setup
+
+The [checkStyle](https://github.com/checkstyle/checkstyle) plugin verifies that Java code abides by the project style. It runs automatically each time you build the project. If you want to view errors directly in the editor, instead of having to skim through the build output, you can install an Android Studio plugin:
+- Go to `File -> Settings -> Plugins`, search for `checkstyle` and install `CheckStyle-IDEA`.
+- Go to `File -> Settings -> Tools -> Checkstyle`.
+- Add NewPipe's configuration file by clicking the `+` in the right toolbar of the "Configuration File" list.
+- Under the "Use a local Checkstyle file" bullet, click on `Browse` and pick the file named `checkstyle.xml` in the project's root folder.
+- Enable "Store relative to project location" so that moving the directory around does not create issues.
+- Insert a description in the top bar, then click `Next` and then `Finish`.
+- Activate the configuration file you just added by enabling the checkbox on the left.
+- Click `Ok` and you are done.
+
+### ktlint setup
+
+The [ktlint](https://github.com/pinterest/ktlint) plugin does the same job as checkStyle for Kotlin files. Installing the related plugin is as simple as going to `File -> Settings -> Plugins`, searching for `ktlint` and installing `Ktlint (unofficial)`.
 
 ## Communication
 
-* There is an IRC channel on Freenode which is regularly visited by the core team and other developers:
-  [#newpipe](irc:irc.freenode.net/newpipe). [Click here for Webchat](https://webchat.freenode.net/?channels=newpipe)!
-* If you want to get in touch with the core team or one of our other contributors you can send an email to
-  <a href="mailto:[email protected]">[email protected]</a>. Please do not send issue reports, they will be ignored and remain unanswered! Use the GitHub issue
-  tracker described above!
-* Feel free to post suggestions, changes, ideas etc. on GitHub or IRC!
+* You can post your suggestions, changes, ideas etc. on either GitHub

.github/FUNDING.yml

@@ -1 +1 @@
-github: XiangRongLin
+liberapay: TeamNewPipe

.github/ISSUE_TEMPLATE/bug_report.md

@@ -7,20 +7,19 @@ assignees: ''
 ---
 
 <!--
-Oh no, a bug! It happens. Thanks for reporting an issue with NewPipe. If this is your first bug report, read the following information before proceeding:
+Oh no, a bug! It happens. Thanks for reporting an issue with NewPipe. To make it easier for us to help you please enter detailed information in the template we have provided below. If a section isn't relevant, just delete it, though it would be helpful to still provide as much detail as possible.-->
 
-Please note, we only support the latest version of NewPipe. In order to check your app version, open the left drawer and click on "About". If you don't have the latest version, upgrade to it and reproduce the problem before opening the issue. The release page (https://github.com/TeamNewPipe/NewPipe/releases/latest) is where you can get it.
+<!-- IF YOU DON'T FILL IN THE TEMPLATE PROPERLY, YOUR ISSUE IS LIABLE TO BE CLOSED. If you feel tired/lazy right now, open your issue some other time. We'll wait. -->
 
-P.S.: Our contribution guidelines might be a nice document to read before you fill out the report :) You can find it at https://github.com/TeamNewPipe/NewPipe/blob/HEAD/.github/CONTRIBUTING.md
+<!-- The comments between these brackets won't show up in the submitted issue (as you can see in the Preview). -->
 
-To make it easier for us to help you please enter detailed information in the template we have provided below. If a section isn't relevant, just delete it, though it would be helpful to still provide as much detail as possible.
--->
-
-<!-- The comments between these brackets won't show up in the submitted issue (as you can see in the preview). -->
+### Checklist
+<!-- This checklist is COMPULSORY. The first box has been checked for you to show you how it is done. -->
 
-### Version
-<!-- Which version are you using? Hopefully the latest! We just told you that above! -->
--
+- [x] I am using the latest version - x.xx.x <!-- Check https://github.com/TeamNewPipe/NewPipe/releases -->
+- [ ] I checked, but didn't find any duplicates (open OR closed) of this issue in the repo. <!-- Seriously, check. O_O -->
+- [ ] I have read the contribution guidelines given at https://github.com/TeamNewPipe/NewPipe/blob/HEAD/.github/CONTRIBUTING.md.
+- [ ] This issue contains only one bug. I will open one issue for every bug report I want to file.
 
 ### Steps to reproduce the bug
 <!--
@@ -31,16 +30,37 @@ To make it easier for us to help you please enter detailed information in the te
 
 <!-- If you can't cause the bug to show up again reliably (and hence don't have a proper set of steps to give us), please still try to give as many details as possible on how you think you encountered the bug. -->
 
+
+### Actual behaviour
+<!-- Tell us what happens with the steps given above. -->
+
+
+
 ### Expected behavior
 <!-- Tell us what you expect to happen. -->
 
-### Actual behaviour
-<!-- Tell us what happens instead. -->
+
 
 ### Screenshots/Screen recordings
-<!-- If applicable, add screenshots or a screen recording to help explain your problem. GitHub supports uploading them directly in the issue text box. If your file is too big for Github to accept, feel free to paste a link from an image/video hoster here instead. -->
+<!-- If applicable, add screenshots or a screen recording to help explain your problem. GitHub supports uploading them
+directly in the issue text box. If your file is too big for Github to accept, feel free to paste a link from an
+image/video hoster here instead. -->
+<
+<!-- DON'T POST SCREENSHOTS OF THE ERROR PAGE. Use the buttons given on the error page to paste the error as text in the
+Logs section below. -->
+
 
 ### Logs
-<!-- If your bug includes a crash (where you're shown the Error Report page with a bunch of info), copy it to the clipboard (there is a share button for this), head over to our bug report to markdown converter at https://teamnewpipe.github.io/CrashReportToMarkdown/ and paste it. Copy the converted text (it is MUCH easier to read this way) from there and paste it here: -->
+<!-- If your bug includes a crash (where you're shown the Error Report page with a bunch of info), tap on "Copy
+formatted report" at the bottom and paste it here: -->
 
 <!-- That's right, here! -->
+
+
+
+<!-- Please fill this section if you did not provide a log generated by NewPipe -->
+
+### Device info
+
+ - Android version/Custom ROM version:
+ - Device model:

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: 💬 IRC
+    url: https://web.libera.chat/#newpipe
+    about: Chat with us via IRC for quick Q/A
+  - name: 💬 Matrix
+    url: https://matrix.to/#/#newpipe:libera.chat
+    about: Chat with us via Matrix for quick Q/A

.github/ISSUE_TEMPLATE/feature_request.md

@@ -5,35 +5,20 @@ labels: enhancement
 assignees: ''
 
 ---
-<!-- Hey. Our contribution guidelines (https://github.com/TeamNewPipe/NewPipe/blob/HEAD/.github/CONTRIBUTING.md) might be an appropriate
- document to read before you fill out the request :) -->
+<!-- IF YOU DON'T FILL IN THE TEMPLATE PROPERLY, YOUR ISSUE IS LIABLE TO BE CLOSED. If you are currently unable to do so for any reason, open your issue some other time. We'll wait. -->
 
-<!-- The comments between these brackets won't show up in the submitted issue (as you can see in the preview). -->
-
-#### Describe the feature you want
-<!-- A clear and concise description of what you want to happen. PLEASE MAKE SURE it is one feature ONLY. You should open separate issues for separate feature requests, because those issues will be used to track their status.
-Example: *I think it would be nice if you add feature Y which makes X possible.*
-
-Optionally, also describe alternatives you've considered.
-Example: *Z is also a good alternative. Not as good as Y, but at least...* or *I considered Z, but that didn't turn out to be a good idea because...* -->
 
-<!-- Write below this -->
-
-#### Is your feature request related to a problem? Please describe it
-<!-- A clear and concise description of what the problem is. Maybe the developers could brainstorm and come up with a better solution to your problem. If they exist, link to related Issues and/or PRs for developers to keep track easier.
-Example: *I want to do X, but there is no way to do it.* -->
-
-<!-- Write below this -->
+<!-- The comments between these brackets won't show up in the submitted issue (as you can see in the preview). -->
 
-#### Additional context
-<!-- Add any other context, like screenshots, about the feature request here.
-Example: *Here's a photo of my cat!* -->
+### Checklist
+<!-- This checklist is COMPULSORY. The first box has been checked for you to show you how it is done. -->
 
-<!-- Write below this -->
+- [x] I checked, but didn't find any duplicates (open OR closed) of this issue in the repo. <!-- Seriously, check. O_O -->
+- [ ] I have read the contribution guidelines given at https://github.com/TeamNewPipe/NewPipe/blob/HEAD/.github/CONTRIBUTING.md.
+- [ ] This issue contains only one feature request. I will open one issue for every feature I want to request.
 
-#### How will you/everyone benefit from this feature?
-<!-- Convince us! How does it change your NewPipe experience and/or your life?
-The better this paragraph is, the more likely a developer will think about working on it.
-Example: *This feature will help us colonize the galaxy! -->
+#### What feature do you want?
+<!-- Explain how you want the app's look or behavior to change to suit your needs. -->
 
-<!-- Write below this -->
+#### Why do you want this feature?
+<!-- Describe any problem or limitation you come across while using the app which would be solved by this feature. -->

.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,23 @@
+---
+name: Question
+about: Ask about anything NewPipe-Zing related
+labels: question
+assignees: ''
+
+---
+
+<!-- IF YOU DON'T FILL IN THE TEMPLATE PROPERLY, YOUR ISSUE IS LIABLE TO BE CLOSED. If you feel tired/lazy right now, openyour issue some other time. We'll wait. -->
+
+<!-- The comments between these brackets won't show up in the submitted issue (as you can see in the Preview). -->
+
+### Checklist
+<!-- This checklist is COMPULSORY. The first box has been checked for you to show you how it is done. -->
+- [x] I checked, but didn't find any duplicates (open OR closed) of this issue in the repo. <!-- Seriously, check. O_O (If there's already an issue but you'd like to see if something changed, just make a comment on the issue instead of opening a new one.) -->
+- [ ] I have read the contribution guidelines given at https://github.com/TeamNewPipe/NewPipe/blob/HEAD/.github/CONTRIBUTING.md.
+
+#### What's your question(s)?
+
+
+#### Additional context
+<!-- Add any other context, like screenshots or links, about the question here.
+Example: *Here's a photo of my cat!* -->