Updated Contributing to Jellyfin (markdown)

master
Joshua M. Boniface 6 years ago
parent c632a2aa34
commit 004ea977fe

@ -30,7 +30,7 @@ We adhere to a fairly standard fork-and-PR model of development:
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.
3. Submit a pull request from your feature branch back to the upstream `dev` branch. PRs that target `master` will be changed to target `dev`, so please double-check this when submitting.
Please ensure you provide a detailed explanation, in each pull request discription, of what problems the PR solves (with action keywords and links to issue numbers if possible), and how the PR solves them. This aids both in review, as well as in future understanding of why a given set of changes were made. More detail is always better here.
@ -38,9 +38,20 @@ All PRs to the `develop` branch require review by at least 1 member of the core
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.
### Example setup procedure on Linux with GitHub SSH access:
1. On GitHub, "Fork" the Jellyfin repo to your own user.
2. From your copy, clone it down: ```git clone git@github.com:yourname/jellyfin.git```
3. Add the "upstream" remote: ```git remote add upstream git@github.com:jellyfin/jellyfin.git```
4. Initialize submodules: ```git submodule update --init```
5. Update your local branches against upstream `master`/`dev`): ```git fetch --all && git rebase upstream/<BRANCH>```
5. Do new development in a local feature branch off of `dev`: ```git checkout dev && git checkout -b my-feature```
6. Push up your local feature branch once ready: ```git push --set-upstream origin my-feature```
7. On GitHub, do a PR against `dev`.
## CONTRIBUTORS.md
If it's your first time contributing code, please consider adding 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.
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.
## Developer Access

Loading…
Cancel
Save