Skip to content
This repository
Browse code

add CONTRIBUTING.md with some basic information regarding pull requests

  • Loading branch information...
commit 6bb23fdcde435f33dfdcde9fedcbe6752d1a9f9f 1 parent af2886b
Martijn Kaijser authored July 17, 2013

Showing 1 changed file with 74 additions and 0 deletions. Show diff stats Hide diff stats

  1. 74  CONTRIBUTING.md
74  CONTRIBUTING.md
Source Rendered
... ...
@@ -0,0 +1,74 @@
  1
+## Questions about XBMC?
  2
+
  3
+To get your questions answered, please ask in the XBMC [Forum] or on IRC: #xbmc on freenode.net or [webchat] 
  4
+
  5
+Do not open an issue.
  6
+
  7
+## Issue Reports
  8
+
  9
+XBMC uses github for development only, i.e. for pull requests and the discussion of code.
  10
+
  11
+So we use a hook script to automatically close new issue created by you.
  12
+
  13
+If you can, we encourage you to investigate the issue yourself and create a Pull Request for us to review.
  14
+
  15
+For bug reports, feature requests and all other support, please go to http://forum.xbmc.org.
  16
+
  17
+## Pull Requests
  18
+
  19
+- Before creating a pull request please read our general code guidelines that can be found here
  20
+  http://wiki.xbmc.org/index.php?title=XBMC_development
  21
+
  22
+- **Create topic branches**. Don't ask us to pull from your master branch.
  23
+
  24
+- **One pull request per feature**. If you want to do more than one thing, send
  25
+  multiple pull requests.
  26
+
  27
+- **Send coherent history**. Make sure each individual commit in your pull
  28
+  request is meaningful. If you had to make multiple intermediate commits while
  29
+  developing, please squash them before sending them to us. IN the end before merging you may be asked to squash your commit even some more.
  30
+
  31
+Please follow this process; it's the best way to get your work included in the project:
  32
+
  33
+- [Fork](http://help.github.com/fork-a-repo/) the project, clone your fork,
  34
+   and configure the remotes:
  35
+
  36
+```bash
  37
+   # clone your fork of the repo into the current directory in terminal
  38
+   git clone git@github.com:<your username>/OpenELEC.tv.git
  39
+   # navigate to the newly cloned directory
  40
+   cd OpenELEC.tv
  41
+   # assign the original repo to a remote called "upstream"
  42
+   git remote add upstream https://github.com/OpenELEC/OpenELEC.tv.git
  43
+   ```
  44
+
  45
+- If you cloned a while ago, get the latest changes from upstream:
  46
+
  47
+   ```bash
  48
+   # fetch upstream changes
  49
+   git fetch upstream
  50
+   # make sure you are on your 'master' branch
  51
+   git checkout master
  52
+   # merge upstream changes
  53
+   git merge upstream/master
  54
+   ```
  55
+
  56
+- Create a new topic branch to contain your feature, change, or fix:
  57
+
  58
+   ```bash
  59
+   git checkout -b <topic-branch-name>
  60
+   ```
  61
+
  62
+- Commit your changes in logical chunks. or your pull request is unlikely
  63
+   be merged into the main project. Use git's
  64
+   [interactive rebase](https://help.github.com/articles/interactive-rebase)
  65
+   feature to tidy up your commits before making them public.
  66
+
  67
+- Push your topic branch up to your fork:
  68
+
  69
+   ```bash
  70
+   git push origin <topic-branch-name>
  71
+   ```
  72
+
  73
+- [Open a Pull Request](https://help.github.com/articles/using-pull-requests) with a
  74
+    clear title and description.

0 notes on commit 6bb23fd

Please sign in to comment.
Something went wrong with that request. Please try again.