diff options
author | Martijn Kaijser <mcm.kaijser@gmail.com> | 2013-07-17 19:50:54 +0200 |
---|---|---|
committer | Martijn Kaijser <mcm.kaijser@gmail.com> | 2013-07-17 19:50:54 +0200 |
commit | 6bb23fdcde435f33dfdcde9fedcbe6752d1a9f9f (patch) | |
tree | 4c0ed0331b64201b86c442c00ea2531ce14aa0b8 /CONTRIBUTING.md | |
parent | af2886bd5eb983338cee08cd1d0e764b6c96d87d (diff) |
add CONTRIBUTING.md with some basic information regarding pull requests
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 74 |
1 files changed, 74 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..ab79ee8487 --- /dev/null +++ b/CONTRIBUTING.md @@ -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. |