Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

add CONTRIBUTING.md with some basic information regarding pull requests

  • Loading branch information...
commit 6bb23fdcde435f33dfdcde9fedcbe6752d1a9f9f 1 parent af2886b
Martijn Kaijser MartijnKaijser authored
Showing with 74 additions and 0 deletions.
  1. +74 −0 CONTRIBUTING.md
74 CONTRIBUTING.md
View
@@ -0,0 +1,74 @@
+## Questions about XBMC?
+
+To get your questions answered, please ask in the XBMC [Forum] or on IRC: #xbmc on freenode.net or [webchat]
+
+Do not open an issue.
+
+## Issue Reports
+
+XBMC uses github for development only, i.e. for pull requests and the discussion of code.
+
+So we use a hook script to automatically close new issue created by you.
+
+If you can, we encourage you to investigate the issue yourself and create a Pull Request for us to review.
+
+For bug reports, feature requests and all other support, please go to http://forum.xbmc.org.
+
+## Pull Requests
+
+- Before creating a pull request please read our general code guidelines that can be found here
+ http://wiki.xbmc.org/index.php?title=XBMC_development
+
+- **Create topic branches**. Don't ask us to pull from your master branch.
+
+- **One pull request per feature**. If you want to do more than one thing, send
+ multiple pull requests.
+
+- **Send coherent history**. Make sure each individual commit in your pull
+ request is meaningful. If you had to make multiple intermediate commits while
+ 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.
+
+Please follow this process; it's the best way to get your work included in the project:
+
+- [Fork](http://help.github.com/fork-a-repo/) the project, clone your fork,
+ and configure the remotes:
+
+```bash
+ # clone your fork of the repo into the current directory in terminal
+ git clone git@github.com:<your username>/OpenELEC.tv.git
+ # navigate to the newly cloned directory
+ cd OpenELEC.tv
+ # assign the original repo to a remote called "upstream"
+ git remote add upstream https://github.com/OpenELEC/OpenELEC.tv.git
+ ```
+
+- If you cloned a while ago, get the latest changes from upstream:
+
+ ```bash
+ # fetch upstream changes
+ git fetch upstream
+ # make sure you are on your 'master' branch
+ git checkout master
+ # merge upstream changes
+ git merge upstream/master
+ ```
+
+- Create a new topic branch to contain your feature, change, or fix:
+
+ ```bash
+ git checkout -b <topic-branch-name>
+ ```
+
+- Commit your changes in logical chunks. or your pull request is unlikely
+ be merged into the main project. Use git's
+ [interactive rebase](https://help.github.com/articles/interactive-rebase)
+ feature to tidy up your commits before making them public.
+
+- Push your topic branch up to your fork:
+
+ ```bash
+ git push origin <topic-branch-name>
+ ```
+
+- [Open a Pull Request](https://help.github.com/articles/using-pull-requests) with a
+ clear title and description.

add [Forum]: http://forum.xbmc.org/ here ;)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Please sign in to comment.
Something went wrong with that request. Please try again.