From 579f0f23000498a553b3452017c7993636672e0a Mon Sep 17 00:00:00 2001 From: Joshua Boniface Date: Tue, 11 Dec 2018 18:01:42 -0500 Subject: [PATCH 1/2] Add contributing documentation --- CONTRIBUTING.md | 38 ++++++++++++++++++++++++++++++++++++++ README.md | 4 ++++ 2 files changed, 42 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..41fecd610a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,38 @@ +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 healthy. + +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. + +## 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. + +## 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 master branch. + +All PRs require review before merging. Once that is done, if the PR is not tagged with the WIP label, it should be immediately merged by the reviewer assuming that they have write access. If you do not have write access, please eel free to leave reviews as well and suggest changes as they will be taken into account as well. + +## Developer Access + +We are open with granting developer (merge/write) access to those who show interest in contributing and reviewing PRs. Such access can be granted by a current developer. Unruly or abusive developers can be removed at any time by the core team, so please take your responsibility seriously. We're all in this together trying to make the best free software media platform we can. + +## How can I contribute? + +If you're a .NET C# or Javascript developer, please feel free to jump right. 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. diff --git a/README.md b/README.md index e635506a2d..7d4a3f9ea6 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,10 @@ While our first priority is a stable build, we will eventually add features that [Feature Requests](http://feathub.com/jellyfin/jellyfin) +## Contributing to Jellyfin + +Please see our contributing documentation at https://github.com/jellyfin/jellyfin/blob/master/CONTRIBUTING.md + ## Prebuilt Jellyfin packages Prebuild packages are available for Debian/Ubuntu and Arch, and via Docker Hub. From 7556b8d74f900c665e85a854c879f1976c208804 Mon Sep 17 00:00:00 2001 From: Joshua Boniface Date: Tue, 11 Dec 2018 18:36:23 -0500 Subject: [PATCH 2/2] Correct some typos and wording --- CONTRIBUTING.md | 6 ++++-- README.md | 2 +- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 41fecd610a..b5fd212c95 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -27,7 +27,7 @@ We adhere to a fairly standard fork-and-PR model of development: 3. Submit a pull request from your feature branch back to the upstream master branch. -All PRs require review before merging. Once that is done, if the PR is not tagged with the WIP label, it should be immediately merged by the reviewer assuming that they have write access. If you do not have write access, please eel free to leave reviews as well and suggest changes as they will be taken into account as well. +All PRs require review before merging. Once that is done, if the PR is not tagged with the WIP label, it should be immediately merged by the reviewer assuming that they have write access. If you do not have write access, please feel free to leave reviews as well and suggest changes as they will be taken into account as well. ## Developer Access @@ -35,4 +35,6 @@ We are open with granting developer (merge/write) access to those who show inter ## How can I contribute? -If you're a .NET C# or Javascript developer, please feel free to jump right. 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. +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! + + 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. diff --git a/README.md b/README.md index 7d4a3f9ea6..d95bdd5c09 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ While our first priority is a stable build, we will eventually add features that ## Contributing to Jellyfin -Please see our contributing documentation at https://github.com/jellyfin/jellyfin/blob/master/CONTRIBUTING.md +If you're interested in contributing, please see [CONTRIBUTING.md](https://github.com/jellyfin/jellyfin/blob/master/CONTRIBUTING.md). ## Prebuilt Jellyfin packages