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 Contributing to Jellyfin (markdown)

Joshua M. Boniface 2019-01-01 16:14:44 -05:00
parent 37e5fc3ecd
commit a6b706c59c
1 changed files with 3 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
Contributing-to-Jellyfin.md

@ -12,27 +12,9 @@ The Jellyfin project consists of a C# core server, a Javascript-based UI, and a
The best way to get going is to look through the [Issues list](https://github.com/jellyfin/jellyfin/issues), find an issue you would like to work on, and start hacking. Issues are triaged regularly by the administrative team, and labels assigned that should help you find issues within your skill-set.
### Major Issue Types
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.
These labels help determine how critical an issue is:
### Major Issue Types
* `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.
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.
A list of issue types can be found on the [Issue guidelines](IssueGuidelines#issue-labels) page.
### What if there isn't an issue?
@ -90,25 +72,7 @@ Even if you can't contribute code, you can still help Jellyfin! The two main thi
## Issue guidelines
Issues should be one of three things:
1. A software bug with Jellyfin.
1. A feature request or suggestion.
1. A task to be done with Jellyfin.
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).
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. Please include any log output, configuration options, and system details you can in the initial issue, and provide anything requested as quickly as possible.
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).
### Searching for issues and upvoting
Before opening an issue, please searched both open and closed issues 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.
Please see the [Issue guidelines](IssueGuidelines) page for details.
## Documentation