256 lines
10 KiB
HTML
256 lines
10 KiB
HTML
<!DOCTYPE html>
|
|
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
|
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
|
|
<link rel="shortcut icon" href="../img/favicon.ico">
|
|
<title>Maintainers' Section - NewPipe Documentation</title>
|
|
<!-- local fonts -->
|
|
<link rel="stylesheet" href="../css/local_fonts.css" type="text/css" />
|
|
|
|
<link rel="stylesheet" href="../css/theme.css" type="text/css" />
|
|
<link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
|
|
<link rel="stylesheet" href="../css/theme_child.css" type="text/css" />
|
|
<!-- local code syntax highlighting -->
|
|
<link rel="stylesheet" href="../css/github.min.css" type="text/css" />
|
|
<link rel="stylesheet" href="../css/highlight.css" type="text/css" />
|
|
|
|
<script>
|
|
// Current page data
|
|
var mkdocs_page_name = "Maintainers' Section";
|
|
var mkdocs_page_input_path = "07_maintainers_view.md";
|
|
var mkdocs_page_url = null;
|
|
</script>
|
|
|
|
<script src="../js/jquery-2.1.1.min.js" defer></script>
|
|
<script src="../js/modernizr-2.8.3.min.js" defer></script>
|
|
<script src="../js/highlight.min.js"></script>
|
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav" role="document">
|
|
|
|
<div class="wy-grid-for-nav">
|
|
|
|
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
|
<div class="wy-side-nav-search">
|
|
<a href=".." class="icon icon-home"> NewPipe Documentation</a>
|
|
<div role="search">
|
|
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
|
|
</form>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|
<ul class="current">
|
|
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<a class="" href="..">Welcome to NewPipe</a>
|
|
</li>
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<a class="" href="../00_Prepare_everything/">Before You Start</a>
|
|
</li>
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<a class="" href="../01_Concept_of_the_extractor/">Concept of the Extractor</a>
|
|
</li>
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<a class="" href="../02_Concept_of_LinkHandler/">Concept of the LinkHandler</a>
|
|
</li>
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<a class="" href="../03_Implement_a_service/">Implementing a Service</a>
|
|
</li>
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<a class="" href="../04_Run_changes_in_App/">Testing Your Changes in the App</a>
|
|
</li>
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<a class="" href="../05_releasing/">Releasing a New NewPipe Version</a>
|
|
</li>
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<a class="" href="../06_documentation/">About This Documentation</a>
|
|
</li>
|
|
|
|
<li class="toctree-l1 current">
|
|
|
|
<a class="current" href="./">Maintainers' Section</a>
|
|
<ul class="subnav">
|
|
|
|
<li class="toctree-l2"><a href="#maintainers-section">Maintainers' Section</a></li>
|
|
|
|
<ul>
|
|
|
|
<li><a class="toctree-l3" href="#keep-it-streamlined">Keep it Streamlined</a></li>
|
|
|
|
<li><a class="toctree-l3" href="#bugfixes">Bugfixes</a></li>
|
|
|
|
<li><a class="toctree-l3" href="#features">Features</a></li>
|
|
|
|
<li><a class="toctree-l3" href="#pull-requests">Pull Requests</a></li>
|
|
|
|
<li><a class="toctree-l3" href="#community">Community</a></li>
|
|
|
|
</ul>
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
|
|
|
|
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="..">NewPipe Documentation</a>
|
|
</nav>
|
|
|
|
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content">
|
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href="..">Docs</a> »</li>
|
|
|
|
|
|
|
|
<li>Maintainers' Section</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main">
|
|
<div class="section">
|
|
|
|
<h1 id="maintainers-section">Maintainers' Section</h1>
|
|
<p>These are some basic principles that we want maintainers to follow when maintaining NewPipe.</p>
|
|
<h3 id="keep-it-streamlined">Keep it Streamlined</h3>
|
|
<p>NewPipe is a media player for devices on the Android platform, thus it is intended to be used for entertainment. This means it does not have to be some professional
|
|
application, and it does not have to be complicated to be used.
|
|
However NewPipe might not focus on the casual user completely as there are
|
|
some features designed for more experienced users which may require some knowledge about
|
|
code, however in essence NewPipe should be easy to use, even for an average Android user.</p>
|
|
<ol>
|
|
<li><strong>Don't add too many special
|
|
features.</strong> NewPipe does not have to be an airplane cockpit. Do not try to fill every single niche that might exist. If people wanted more advanced features, they
|
|
would use professional tools. If you add too much functionality, you add complexity, and complexity scares away the average user. Focus on NewPipe's scope as a <strong>media player</strong> for the end user, and only as such. </li>
|
|
<li><strong>Usability of the user interface should be prioritized.</strong> Try to make it comply with
|
|
<a href="https://material.io/design/guidelines-overview/">material design guidelines</a>.</li>
|
|
</ol>
|
|
<h3 id="bugfixes">Bugfixes</h3>
|
|
<p><img alt="kde_in_a_nutshell" src="../img/kde_in_a_nutshell.jpg" />]</p>
|
|
<p><em>Disclaimer: This is a meme. Please don't take it personally.</em></p>
|
|
<p><strong>Always prioritize fixing bugs</strong>, as the best application with the best features
|
|
does not help much if it is broken, or annoying to use. Now if a program
|
|
is in an early stage it is quite understandable that many things break. This
|
|
is one reason why NewPipe still has no "1" in the beginning of its version
|
|
number.
|
|
By now, NewPipe is in a stage where there should be a strong focus on
|
|
stability.</p>
|
|
<ol>
|
|
<li>If there are multiple Pull Requests open, check the ones with bugfixes first.</li>
|
|
<li>Do not add too many features every version, as every feature will inevitably
|
|
introduce more bugs. It is OK if PRs remain open for a while, but don't leave them open for too long.</li>
|
|
<li>If there are bugs that are stale, or open for a while bump them from time
|
|
to time, so devs know that there is still something left to fix.</li>
|
|
<li>Never merge PRs with known issues. From our perception the community does not like to fix bugs, this is why you as a maintainer should
|
|
especially focus on pursuing bugs.</li>
|
|
</ol>
|
|
<h3 id="features">Features</h3>
|
|
<p>Features are also something that can cause a headache. You should not blindly
|
|
say yes to features, even if they are small, but you should also not immediately say no. If you are not sure, try the feature, look into the
|
|
code, speak with the developer, and then make a decision. When considering a feature, ask yourself the following questions:</p>
|
|
<ul>
|
|
<li>Was the feature requested by only a few, or by many?<ul>
|
|
<li>Avoid introducing niche features to satisfy a small handful of users.</li>
|
|
</ul>
|
|
</li>
|
|
<li>Was the code rushed and messy, and could a cleaner solution be made? <ul>
|
|
<li>A pull request that adds a frequently requested feature could implement the feature in a messy way. Such PRs should not be merged as it will likely cause problems later down the line, either through problems of extending the feature by introducing many bugs, or simply by breaking the architecture or the philosophy of NewPipe.</li>
|
|
</ul>
|
|
</li>
|
|
<li>Does the amount of code justify the feature's purpose? <ul>
|
|
<li>Use critical thinking when considering new features and question
|
|
whether that features makes sense, is useful, and if it would benefit NewPipe's users.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h3 id="pull-requests">Pull Requests</h3>
|
|
<p>If a PR contains more than one feature/bugfix, be cautious. The more stuff a PR changes, the longer it will take to be added.
|
|
There also might be things that seem to not have any issues, but other things will, and this would prevent you from merging a PR. This is why it is encouraged to keep one change per pull request, and you should insist that contributors divide such PRs into multiple smaller PRs when possible.</p>
|
|
<h3 id="community">Community</h3>
|
|
<p>When you talk to the community, stay friendly and respectful with good etiquette.
|
|
When you have a bad day, just don't go to GitHub (advice from our experience ;D ).</p>
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|
|
|
|
|
<a href="../06_documentation/" class="btn btn-neutral" title="About This Documentation"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
|
|
</div>
|
|
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<!-- Copyright etc -->
|
|
|
|
</div>
|
|
|
|
Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
<div class="rst-versions" role="note" style="cursor: pointer">
|
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
|
|
|
|
|
<span><a href="../06_documentation/" style="color: #fcfcfc;">« Previous</a></span>
|
|
|
|
|
|
</span>
|
|
</div>
|
|
<script>var base_url = '..';</script>
|
|
<script src="../js/theme.js" defer></script>
|
|
<script src="../search/main.js" defer></script>
|
|
|
|
</body>
|
|
</html>
|