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 15:51:47 -05:00
parent f3bcd664cf
commit 33990b9882
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
Contributing-to-Jellyfin.md

@ -2,22 +2,22 @@ Thank you for your interest in contributing to Jellyfin! We are a community proj
This page details how you can help contribute to Jellyfin. Please give this a read-through before opening an Issue or PR, or if you're not sure how to do either.
Are you a coder and interested in [writing and maintaining C# or Javascript code](https://github.com/jellyfin/jellyfin/wiki/Contributing-to-Jellyfin#contributing-code-to-jellyfin)? Or are you not a coder and interested in [reporting an issue or contributing in other ways](https://github.com/jellyfin/jellyfin/wiki/Contributing-to-Jellyfin#other-contributions-to-jellyfin)?
Are you a coder and interested in [writing and maintaining C# or Javascript code](https://github.com/jellyfin/jellyfin/wiki/Contributing-to-Jellyfin#contributing-code-to-jellyfin)? Or are you not a coder and interested in [reporting an issue or contributing in other ways](https://github.com/jellyfin/jellyfin/wiki/Contributing-to-Jellyfin#other-contributions-to-jellyfin)?
# Contributing Code to Jellyfin
The Jellyfin project consists of a C# core server, a Javascript-based UI, and a number of client applications written in various languages and frameworks. If you have experience with these languages, we're always grateful for any contributions you might want to make!
The Jellyfin project consists of a C# core server, a Javascript-based UI, and a number of client applications written in various languages and frameworks. If you have experience with these languages, we're always grateful for any contributions you might want to make!
## What should you do?
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.
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 two are broad categories for which part of Jellyfin the issue affects:
These first two 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.
* `build/platform`: An issue that mainly relates to building or packaging the project.
These types help determine how critical an issue is:
@ -36,11 +36,11 @@ Finally there are a few more issue types to assist in managing the project:
### What if there isn't an issue?
If there isn't already an issue dealing with the changes you want to make, please [create an issue] to track it first, then ensure your PR(s) reference the issue in question. Especially useful for bugs that are found and then fixed by the author.
If there isn't already an issue dealing with the changes you want to make, please [create an issue] to track it first, then ensure your PR(s) reference the issue in question. Especially useful for bugs that are found and then fixed by the author. Please see the [issue guidelines below](https://github.com/jellyfin/jellyfin/wiki/Contributing-to-Jellyfin#issue-guidelines) for more details.
## How should you make changes?
Once you've found something you want to work on or improve, the next step is to make your changes in the code, test them, then submit a PR. This section details how to go about doing that. For simplicity, all examples assume the developer is operating on Linux with SSH access to GitHub, however the general ideas can be translated to Windows or OSX.
Once you've found something you want to work on or improve, the next step is to make your changes in the code, test them, then submit a PR. This section details how to go about doing that. For simplicity, all examples assume the developer is operating on Linux with SSH access to GitHub, however the general ideas can be translated to Windows or OSX.
If you aren't familiar with Git, we recommend the [official documentation](https://git-scm.com/book/en/v2/Getting-Started-About-Version-Control) to get yourself going.
@ -67,7 +67,7 @@ Jellyfin uses a "feature branch" model, though usually a feature branch is local
### CONTRIBUTORS.md
If it's your first time contributing code, please add yourself to the `CONTRIBUTORS.md` file at the bottom of the `Jellyfin Contributors` section. While GitHub does track this, having the written document makes things clearer if the code leaves GitHub and lets everyone quickly see who's worked on the project for copyright or praise!
If it's your first time contributing code, please add yourself to the `CONTRIBUTORS.md` file at the bottom of the `Jellyfin Contributors` section. While GitHub does track this, having the written document makes things clearer if the code leaves GitHub and lets everyone quickly see who's worked on the project for copyright or praise!
### Pull Request guidelines