270 lines
14 KiB
HTML

<!DOCTYPE html>
<html lang="en-us">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width,minimum-scale=1,initial-scale=1">
<meta name="theme-color" content="#FF8E03">
<meta property="og:title" content="Issue Labels &middot; Citra" />
<meta property="og:site_name" content="Citra" />
<meta property="og:url" content="https://citra-emu.org/wiki/issue-labels/" />
<meta property="og:description" content="We issue several kinds of issue labels in GitHub&rsquo;s issue tracker to help organize issue. This page contains descriptions of each labels. If you&rsquo;re a developer and add a new label, please try to remember to document it here.
&ldquo;A-&rdquo; labels (&ldquo;Area&rdquo;) Broadly identify the area or module of the code this issue is related to.
A-audio: Audio output, DSP or CSND emulation. A-build-system: Our CMake build system or build automation on Travis CI or AppVeyor." />
<meta name="description" content="We issue several kinds of issue labels in GitHub&rsquo;s issue tracker to help organize issue. This page contains descriptions of each labels. If you&rsquo;re a developer and add a new label, please try to remember to document it here.
&ldquo;A-&rdquo; labels (&ldquo;Area&rdquo;) Broadly identify the area or module of the code this issue is related to.
A-audio: Audio output, DSP or CSND emulation. A-build-system: Our CMake build system or build automation on Travis CI or AppVeyor." />
<meta property="og:type" content="website" />
<link rel="icon" href="https://citra-emu.org/favicon.ico" />
<link rel="shortcut icon" href="https://citra-emu.org/favicon.ico" type="image/x-icon" />
<link rel="canonical" href="https://citra-emu.org/wiki/issue-labels/">
<title>Issue Labels - Citra</title>
<link href="https://fonts.googleapis.com/css?family=Ubuntu|Dosis" rel="stylesheet">
<link rel="stylesheet" href="https://citra-emu.org/scss/style.min.css" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.1.1/jquery.min.js"
integrity="sha256-hVVnYaiADRTO2PzUGmuLJr8BLUSjGIZsDYGmIJLv2b8=" crossorigin="anonymous"></script>
<script async src="https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js"></script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-73966905-1', 'auto');
ga('send', 'pageview');
</script>
</head>
<body>
<nav class="navbar navbar-default navbar-wrapper navbar-fixed-top">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar"
aria-expanded="false" aria-controls="navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="/">&nbsp;</a>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li class="index-1 first"><a href="/" title="Blog Posts">Blog</a></li>
<li class="index-2"><a href="/download/" title="Download Citra">Download</a></li>
<li class="index-3"><a href="/help/" title="Help">Help</a></li>
<li class="index-4"><a href="/wiki/faq/" title="Frequently Asked Questions">FAQ</a></li>
<li class="index-5"><a href="/game/" title="Game Compatibility">Compatibility</a></li>
<li class="index-6"><a href="/wiki/home/" title="Wiki Homepage">Wiki</a></li>
<li class="index-7 dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown"
role="button" aria-haspopup="true" aria-expanded="false">
Social <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li class="index-1 first"><a href="/rules/" title="Community Rules">Rules</a></li>
<li class="index-2"><a href="https://community.citra-emu.org/" title="Forums">Community Forums</a></li>
<li class="index-3 last"><a href="/discord/" title="Discord Server">Discord Chat</a></li>
</ul>
</li>
<li class="index-8 dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button"
aria-haspopup="true" aria-expanded="false">
Media <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li class="index-1 first"><a href="/screenshots/" title="Screenshots">Screenshots</a></li>
<li class="index-2 last"><a href="https://www.youtube.com/channel/UC_dcdgzuapBtAY4ol3x-90Q"
title="YouTube Channel">Videos</a></li>
</ul>
</li>
<li class="index-9 last"><a href="https://www.patreon.com/citraemu" title="Patreon">Patreon</a></li>
</ul>
</div>
</div>
</nav>
<div id="mainContainer" class="container" >
<div class="row">
</div>
<div class="row row-fluid">
<div id="content" class="col-xs-12 col-sm-12 col-md-9 col-lg-9 pull-right">
<h1>Issue Labels</h1>
<p>We issue several kinds of issue labels in GitHub&rsquo;s issue tracker to help organize issue. This page contains descriptions of each labels. If you&rsquo;re a developer and add a new label, please try to remember to document it here.</p>
<h2 id="a--labels-area">&ldquo;A-&rdquo; labels (&ldquo;Area&rdquo;)</h2>
<p>Broadly identify the area or module of the code this issue is related to.</p>
<ul>
<li><strong>A-audio</strong>: Audio output, DSP or CSND emulation.</li>
<li><strong>A-build-system</strong>: Our CMake build system or build automation on Travis CI or AppVeyor.</li>
<li><strong>A-cpu</strong>: CPU emulation, either the interpreter (Dyncom) or JIT recompiler (Dynarmic).</li>
<li><strong>A-filesystem</strong>: Emulation of the FS service and code which is used to implement it. (Savefiles, SD access, etc.)</li>
<li><strong>A-frontend</strong>: The SDL or Qt frontends. (Any code in <code>citra</code> or <code>citra-qt</code>.)</li>
<li><strong>A-graphics</strong>: The issue affects graphical output of the emulator (glitches, missing objects, ..).</li>
<li><strong>A-kernel</strong>: Core 3DS kernel HLE. Includes all syscall handling, kernel objects, scheduler, etc. Does <em>not</em> include HLE services.</li>
</ul>
<h2 id="e--labels-effort">&ldquo;E-&rdquo; labels (&ldquo;Effort&rdquo;)</h2>
<p>Attempt to gauge the difficulty or effert needed to fix or implement an issue. Useful for beginners looking for tasks to do. In any case it&rsquo;s recommended that contributors join the IRC channel and talk with a developer first before starting non-trivial work.</p>
<ul>
<li><strong>E-easy</strong>: Easy tasks that shouldn&rsquo;t require critical design work or deep knowledge of the 3DS internals.</li>
<li><strong>E-intermediate</strong>: Tasks requiring more effort which should probably have input from existing contributors.</li>
<li><strong>E-hard</strong>: Requires major design work or very good knowledge of the 3DS system.</li>
</ul>
<h2 id="f--labels-feature">&ldquo;F-&rdquo; labels (&ldquo;Feature&rdquo;)</h2>
<p>Once an issue has been identified to be caused by a specific piece of code / feature in Citra it will be tagged with these. We usually call each feature by how it&rsquo;s named on the Citra side, however, some features map exactly to 3DS or unimplemented features.</p>
<ul>
<li><strong>F-audio:csnd</strong>: This issue is due to the unimplemented csnd service</li>
<li><strong>F-audio:dsp-hle</strong>: This issue is in the HLE implementation of the DSP firmware</li>
<li><strong>F-audio:pipe3</strong>: This issue is due to an unimplemented DSP pipe</li>
<li><strong>F-cpu:interpreter</strong>: The CPU interpreter is affected exclusively</li>
<li><strong>F-cpu:jit</strong>: The CPU JIT is affected exclusively</li>
<li><strong>F-gpu:depth</strong>: Emulated depthbuffer is wrong or depth comparisons fail</li>
<li><strong>F-gpu:gl-renderer</strong>: The OpenGL renderer is affected exclusively</li>
<li><strong>F-gpu:gs</strong>: Geometry Shaders of the 3DS GPU</li>
<li><strong>F-gpu:proctex</strong>: Texture unit 3 (Produceral textures) of the 3DS GPU</li>
<li><strong>F-gpu:scissor</strong>: GPU Scissor testing</li>
<li><strong>F-gpu:shader-jit</strong>: The Shader JIT is affected exclusively</li>
<li><strong>F-gpu:shadow-2d</strong>: 2D Texture Shadow feature of the 3DS GPU</li>
<li><strong>F-gpu:shadow-cube</strong>: Cubemap Shadow feature of the 3DS GPU</li>
<li><strong>F-gpu:sw-rasterizer</strong>: The software renderer is affected exclusively</li>
<li><strong>F-gpu:tex-fwd</strong>: This problem is related to our texture-forwarding (or upscaled rendering)</li>
<li><strong>F-gpu:texture-cube</strong>: Cubemapping feature of the 3DS GPU</li>
<li><strong>F-gpu:vk-renderer</strong>: The Vulkan renderer is affected exclusively</li>
</ul>
<h2 id="pr-labels">&ldquo;pr:&rdquo; labels</h2>
<p>Used exclusively to tag pull requests. Not used very often.</p>
<ul>
<li><strong>pr:abandoned</strong>: PR hasn&rsquo;t had any activity from the author in a while.</li>
<li><strong>pr:conflicted</strong>: PR has conflicts with master and needs a rebase.</li>
<li><strong>pr:needs-review</strong>: PR needs review from a maintainer. (Either because it hasn&rsquo;t been looked at or because it has been updated since the last review.)</li>
<li><strong>pr:needs-work</strong>: PR has been reviewed and changes have been requested.</li>
<li><strong>pr:reviewed</strong>: PR has been reviewed by a maintainer but additional reviews are welcome.</li>
</ul>
<h2 id="t--labels-type">&ldquo;T-&rdquo; labels (&ldquo;Type&rdquo;)</h2>
<p>TODO</p>
<h2 id="misc-labels">Misc. labels</h2>
<ul>
<li><strong>canary-merge</strong>: PR will be auto-merged with <a href="https://github.com/citra-emu/citra-canary">Citra Canary</a> on every build.</li>
</ul>
</div>
<div id="sidebar" class="col-xs-12 col-sm-12 col-md-3 col-lg-3 pull-left">
<div id="advertisement" class = "ad">
<h3>Advertisement</h3>
<ins class="ad adsbygoogle"
style="display:block"
data-ad-client="ca-pub-4126545610079023"
data-ad-slot="4223809695"></ins>
<script>(adsbygoogle = window.adsbygoogle || []).push({});</script>
</div>
<div class="tagcloud hidden-sm hidden-xs">
<h3>News Tag Cloud</h3>
<ul>
<li><a class="taxonomy-citra-release" href="/tags/citra-release">citra-release</a></li>
<li><a class="taxonomy-feature-update" href="/tags/feature-update">feature-update</a></li>
<li><a class="taxonomy-progress-report" href="/tags/progress-report">progress-report</a></li>
</ul>
</div>
<div id="twitter" class="hidden-sm hidden-xs">
<a class="twitter-timeline" data-tweet-limit="3" href="https://twitter.com/citraemu?ref_src=twsrc%5Etfw">Tweet Feed</a>
<script async src="https://platform.twitter.com/widgets.js" charset="utf-8"></script>
</div>
</div>
</div>
</div>
<div id="footer" class="container">
<div class="row">
<div class="col-md-2">
<h1>Citra</h1>
<a href="/entry">Blog</a>
<a href="/download/">Downloads</a>
<a href="/screenshots/">Screenshots</a>
<a href="https://www.patreon.com/citraemu">Patreon</a>
<a href="/donate/">Donate</a>
</div>
<div class="col-md-2">
<h1>Documentation</h1>
<a href="/help/">Help Documents</a>
<a href="/game/">Compatibility</a>
<a href="/wiki/home/">Wiki</a>
<a href="/wiki/faq/">FAQ</a>
</div>
<div class="col-md-2">
<h1>Blog</h1>
<a href="/entry">News &amp; Articles</a>
<a href="https://citra-emu.org/index.xml">RSS 2.0</a>
</div>
<div class="col-md-2">
<h1>Social</h1>
<a href="https://www.youtube.com/channel/UC_dcdgzuapBtAY4ol3x-90Q">YouTube</a>
<a href="https://www.facebook.com/citra.emu">Facebook</a>
<a href="https://twitter.com/citraemu">Twitter</a>
<a href="https://community.citra-emu.org/">Forums</a>
<a href="/discord">Discord</a>
<a href="/chat">IRC</a>
</ul>
</div>
<div class="col-md-2">
<h1>Get Involved</h1>
<a href="https://github.com/citra-emu/citra">GitHub / Source</a>
<a href="https://github.com/citra-emu/citra/issues">Issues</a>
<a href="https://github.com/citra-emu/citra/pulls">Pull Requests</a>
</div>
</div>
<div id="footer-bottom">
<div id="footer-brand"></div>
<div id="footer-legal">Copyright © 2024 Citra Emulator Project</div>
</div>
</div>
<script src="https://citra-emu.org/js/script.js"></script>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/baguettebox.js/1.10.0/baguetteBox.min.css" type="text/css" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/baguettebox.js/1.10.0/baguetteBox.min.js" type="text/javascript"></script>
<script type="text/javascript">
window.addEventListener("DOMContentLoaded", function() {
baguetteBox.run('.is-img-preview');
});
</script>
</body>
</html>