alteropen/jellyfin
1
0
Fork 0
mirror of https://github.com/jellyfin/jellyfin.git synced 2026-05-21 16:17:00 +01:00
Code Issues Actions 9 Packages Projects Releases Wiki Activity

Created Contributing to Jellyfin (markdown)

Joshua M. Boniface
2018-12-14 16:15:44 -05:00
parent 38d71261bd
commit c48825b5de
1 changed files with 44 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
Contributing-to-Jellyfin.md Normal file

@@ -0,0 +1,44 @@
Contributing to Jellyfin
============
Thank you for your interest in contributing to Jellyfin! We are a community project made up of volunteers doing our best to keep a Free Software version of Emby alive and moving forward.
This document describes how to contribute to Jellyfin via GitHub, and is applicable to anyone who might wish to open up an issue or do a pull request. Please give it a read-through first.
Before contributing it is advised to read over our [naming conventions](https://github.com/jellyfin/jellyfin/wiki/Naming-Conventions-for-Jellyfin) to ensure consistent usage of the name.
## How can I contribute?
If you're a .NET C# or Javascript developer, please feel free to jump right in - we can use all the help we can get! A section on our Pull Request policy is below.
If you're not a developer, please consider helping out by contributing documentation, testing the latest releases and reporting bugs, or by telling your friends about the project! Any little bit helps.
## Issues
Issues should be one of three things:
1. A software bug with Jellyfin.
2. A feature request or suggestion.
3. A task to be done with Jellyfin.
All other discussions should be directed towards the [Jellyfin Riot channel](https://matrix.to/#/#jellyfin:matrix.org), the [Jellyfish development Riot channel](https://matrix.to/#/#jellyfin-dev:matrix.org), or [our subreddit](https://reddit.com/r/jellyfin).
When writing an issue, please ensure you capture as much relevant detail as possible - having to request additional information just leads to wasted time. Please include any log output, configuration options, and system details you can get in the initial issue, and provide anything requested as quickly as possible.
## Pull Requests
We adhere to a fairly standard fork-and-PR model of development:
1. Fork a copy of the Jellyfin repository to your own user.
2. Make your changes on a local feature branch of your copy of the repository.
3. Submit a pull request from your feature branch back to the upstream `develop` branch. PRs that target `master` will be changed to target `develop`, so please double-check this when submitting.
All PRs to the `develop` branch require review by at least 1 member of the core team. Once that is done, if the PR is not tagged with the WIP label, it should be merged by the reviewer if able. We do however encourage reviews from any contributor as more eyes always helps.
Merges from `develop` back into `master` will occur when needed, and must be reviewed by at least 2 members of the core team. Once that is done, a third core team member should review the reviews and merge the commit.
## Developer Access
Currently the core team consists of @joshuaboniface, @nvllsum, @JustAMan, @dcrdev, and @anthonylavado. One of the core team members is required to merge code. We may augment this team in the future at our discretion, but for now we seek to keep this team a small group while we establish ourselves.