code.vuplus.com Git - vuplus_xbmc/blob - CONTRIBUTING.md

   1 ### Introduction
   2
   3 **Kodi** uses Github for development only, i.e. for *pull requests* and the review of such code.
   4 **Do not open** an issue on Github for your questions or bug reports.
   5 **Do not comment** on a *pull request* unless you are involved in the testing of such or have something meaningful to contribute.
   6 Not familiar with git? Start by looking at Github's [collaborating pages](https://help.github.com/categories/collaborating/).
   7
   8 #### Questions about Kodi?
   9
  10 To get your questions answered, please ask in the [Kodi community forum's](http://forum.kodi.tv/) or on **IRC:** [#kodi](http://webchat.freenode.net?nick=kodi-contrib&channels=%23kodi&prompt=1&uio=OT10cnVlde) on freenode.net
  11
  12 #### Issue or bug reports and discussions
  13
  14 Issue or bug reports are created and reviewed at [Kodi's bug tracker](http://trac.kodi.tv) using the Kodi forum's *username* and *password*.
  15
  16 If you can, we encourage you to investigate the issue yourself and create a [pull request](https://help.github.com/articles/creating-a-pull-request/) for us to review.
  17
  18 For bug reports and related discussions, feature requests and all other support, please go to [Kodi community forum's](http://forum.kodi.tv/).
  19
  20 #### Pull Requests
  21
  22 Before [creating a pull request](https://help.github.com/articles/creating-a-pull-request/), please read our general code guidelines that can be found at:
  23
  24 - [Code guidelines](http://kodi.wiki/view/Official:Code_guidelines_and_formatting_conventions)
  25 - [Submitting a patch](http://kodi.wiki/view/HOW-TO_submit_a_patch)
  26 - [Kodi development](http://kodi.wiki/view/Development)
  27
  28 ###### General guidelines for creating pull requests:
  29 - **Create topic branches**. Don't ask us to pull from your master branch.
  30 - **One pull request per feature**. If you want to do more than one thing, send multiple *pull requests*.
  31 - **Send coherent history**. Make sure each individual commit in your *pull
  32   request* is meaningful.
  33   If you had to make multiple intermediate commits while developing, please squash them before sending them to us.
  34   In the end before merging you may be asked to squash your commit even some more.
  35
  36 ###### Please follow these guidelines; it's the best way to get your work included in the project!
  37
  38 - [Click here](https://github.com/xbmc/xbmc/fork/) to **fork Kodi** project,
  39    and [configure the remote](https://help.github.com/articles/configuring-a-remote-for-a-fork/):
  40
  41    ```bash
  42    # Clone your fork of kodi's repo into the current directory in terminal
  43    git clone git@github.com:<your github username>/xbmc.git kodi
  44    # Navigate to the newly cloned directory
  45    cd kodi
  46    # Assign the original repo to a remote called "upstream"
  47    git remote add upstream https://github.com/xbmc/xbmc.git
  48    ```
  49
  50 - If you cloned a while ago, get the latest changes from upstream:
  51
  52    ```bash
  53    # Fetch upstream changes
  54    git fetch upstream
  55    # Make sure you are on your 'master' branch
  56    git checkout master
  57    # Merge upstream changes
  58    git merge upstream/master
  59    ```
  60
  61 - Create a new topic branch to contain your feature, change, or fix:
  62
  63    ```bash
  64    git checkout -b <topic-branch-name>
  65    ```
  66
  67 - Commit your changes in logical chunks, or your *pull request* is unlikely to be merged into the main project.
  68    Use git's [interactive rebase](https://help.github.com/articles/interactive-rebase)
  69    feature to tidy up your commits before making them public.
  70
  71 - Push your topic branch up to your fork:
  72
  73    ```bash
  74    git push origin <topic-branch-name>
  75    ```
  76
  77 -  Open a [pull request](https://help.github.com/articles/using-pull-requests) with a
  78    clear title and description.