Skip to content

Latest commit

 

History

History
77 lines (55 loc) · 6.5 KB

CONTRIBUTING.md

File metadata and controls

77 lines (55 loc) · 6.5 KB
Raw

FoxPipe contribution guidelines

Crash reporting

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

  • Already reported? Browse the existing 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.
  • The template: Fill it out, Follow the template! Issues or feature requests not matching the template might be closed.

Code contribution

Guidelines

  • Stick to NewPipe's style conventions of checkStyle and ktlint. They run each time you build the project.
  • Stick to F-Droid contribution guidelines.
  • 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.

Before starting development

  • 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 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 must rebase your branch on the dev branch manually and resolve the conflicts on your own. You can find help on the wiki. Doing this makes the maintainers' job way easier.

IDE setup & building the app

Basic setup

NewPipe is developed using Android Studio. Learn more about how to install it and how it works in the official documentation. 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's inspections useful in helping you to write good code and prevent bugs.

checkStyle setup

The 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 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

  • You can post your suggestions, changes, ideas etc. on either GitHub