Created Issue Labels (markdown)

Yuri Kunde Schlesner 2016-12-15 23:33:22 -08:00
parent 12fd3912a4
commit 800f737b60

46
Issue-Labels.md Normal file

@ -0,0 +1,46 @@
# Issue Labels
We issue several kinds of issue labels in GitHub's issue tracker to help organize issue. This page contains descriptions of each labels. If you're a developer and add a new label, please try to remember to document it here.
## "A-" labels ("Area")
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.
- **A-cpu:** CPU emulation, either the interpreter (Dyncom) or JIT compiler (Dynarmic).
- **A-filesystem:** Emulation of the FS service and code which is used to implement it. (Savefiles, SD access, etc.)
- **A-frontend:** The SDL or Qt frontends. (Any code in `citra` or `citra-qt`.)
- **A-graphics:** Graphics emulation, including vertex shaders, software rasterizer, OpenGL backend and surface cache.
- **A-kernel:** Core 3DS kernel HLE. Includes all syscall handling, kernel objects, scheduler, etc. Does *not* include HLE services.
## "E-" labels ("Effort")
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's recommended that contributors join the IRC channel and talk with a developer first before starting non-trivial work.
- **E-easy:** Easy tasks that shouldn't require critical design work or deep knowledge of the 3DS internals.
- **E-intermediate:** Tasks requiring more effort which should probably have input from existing contributors.
- **E-hard:** Requires major design work or very good knowledge of the 3DS system.
## "F-" labels (?)
TODO
## "pr:" labels
Used exclusively to tag pull requests. Not used very often.
- **pr:abandoned:** PR hasn't had any activity from the author in a while.
- **pr:bleeding-edge-merge:** PR will be auto-merged with [Citra Bleeding Edge](https://github.com/citra-emu/citra-bleeding-edge) on every build.
- **pr:conflicted:** PR has conflicts with master and needs a rebase.
- **pr:needs-review:** PR needs review from a maintainer. (Either because it hasn't been looked at or because it has been updated since the last review.)
- **pr:needs-work:** PR has been reviewed and changes have been requested.
- **pr:reviewed:** PR has been reviewed by a maintainer but additional reviews are welcome.
## "T-" labels ("Type")
TODO
## Misc. labels
TODO