Cutlery/jellyfin
1
0
Fork 0
mirror of https://github.com/jellyfin/jellyfin.git synced 2025-08-11 09:13:54 -04:00
Code Issues Packages Projects Releases Wiki Activity

Updated Issue Guidelines (markdown)

Joshua M. Boniface 2019-01-01 16:14:05 -05:00
parent ad282fc641
commit b334dc6f73
1 changed files with 53 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

77
Issue-Guidelines.md

@ -1,32 +1,61 @@
Before you open the issue, please know that we're currently working very hard to make the software stable. As a result, there are a lot of changes that are happening very quickly. Issues should detail one of three things:
It's extremely helpful if you [search the existing issues](https://github.com/jellyfin/jellyfin/issues?utf8=✓&q=is%3Aissue) to see if your issue has already been reported. 1. A software bug with Jellyfin.
1. A feature request or suggestion.
1. A task to be done with Jellyfin.
Depending on what's going on, please do the following: All other discussions should be directed towards one of the [Jellyfin Riot channels](https://github.com/jellyfin/jellyfin/wiki/Riot-Matrix-Rooms), or [our subreddit](https://reddit.com/r/jellyfin).
0. If you are experiencing the same issue, with the same error message(s), add a [GitHub Reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) :thumbsup: to the top post. # Opening an issue
1. If you find a very similar issue, with close, but slightly different message(s), add a comment explaining what's happening for your system.
2. If you don't find any matches, please open a new issue.
We have a few labels that can help us sort your issue better: When writing an issue, please ensure you capture as much relevant detail as possible - this is very important to assist in troubleshooting and triaging/investigating the issue. Some useful elements include:
Label | Description * How you installed Jellyfin (upgrade/fresh install)
-----------------|--------------------------------------------------------------------------------------- * What platform and operating system you're using (Debian, Arch, Docker, etc.)
backend | For server issues, not app or web UI. Typically used in conjunction with another label * What you were doing that caused the error or issue to appear
bug | For when something just isn't working right * Any relevant log output
build/platform | For problems with building from source, or installing the software packages * Any non-standard configurations you use
documentation | Request changes/additions to any documentation (including this wiki!)
enhancement | Request an improvement to an existing feature
feature | Request a new feature
good first issue | If you are new to the project and want to help, look for these!
UI | For problems with an interface, like the web UI or an app
regression | For issues or PRs that address regressions from a previous stable build
## Details Help! To assist in triaging, if you know which label(s) should applied to your issue, please add them to the beginning of the issue name in square brackes, like this: "[feature][UI] Add the widget to the front panel". Issues will be triaged in time by the administrative team, and these flags will be removed from the title and issue labels added. This is required due to GitHub's permission system. The list of labels can be [found above](https://github.com/jellyfin/jellyfin/wiki/Contributing-to-Jellyfin#major-issue-types).
One last thing: please provide us with as many details as you possibly can. Things that help:
- How you installed Jellyfin (upgrade/fresh install) ### Searching for issues and upvoting
- What platform and operating system you're using (Debian, Arch, Docker, etc.)
- What you were doing that caused the error or issue to appear Before opening an issue, please [search the existing issues](https://github.com/jellyfin/jellyfin/issues?utf8=✓&q=is%3Aissue) to see if a similar problem or feature request has been reported. Duplicate issues clutter the repository and should be avoided.
If you do find an issue that matches, or closely matches, your issue, please make use of the :+1: reaction to confirm the issue also affects you or that you support the feature request. If you wish, add a comment as well describing your version of the issue or feature usecase.
If the existing issue is closed, please read through it to see if the accepted workaround(s) apply to your case. If not, leave a comment and the issue will be reopened. Note that, since PRs go into `dev` first but releases are built from `master`, an issue's fix won't be immediately available in the official sources, but will be included in the next release.
## Issue Link ## Issue Link
Thank you for reading this so far. If you need to, [open an issue](https://github.com/jellyfin/jellyfin/issues/new)!
Once you're ready to open an issue, please [see this page](https://github.com/jellyfin/jellyfin/issues/new)!
# Issue Labels
Jellyfin features a number of issue labels to assist in triaging and managing issues.
### Category Labels
These first three labels are broad categories for which part of Jellyfin the issue affects:
* `UI`: An issue that mainly relates to the UI frontend code.
* `Backend`: An issue that mainly relates to the server backend code.
* `build/platform`: An issue that mainly relates to building or packaging the project.
### Criticality Labels
These labels help determine how critical an issue is:
* `regression`: An issue in need of immediate attention due to a regression from the last build.
* `bug`: A bug in the code that affects normal usage.
* `enhancement`: An issue that requests a modification of an existing feature.
* `feature`: An issue that requests a new feature not present in Jellyfin.
## Management Lables
Finally there are a few more labels to assist in managing the project:
* `Good first issue`: Something that should be very straightforward to do, and is a great place to get started.
* `help wanted`: An issue that currently has no clear expert within the project and could use outside assistance.
* `roadmap`: A meta-issue related to the future roadmap of the project.
* `documentation`: An issue related to the documentation of the project.
* `fork`: An issue related to the forking from Emby.