diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/CONTRIBUTING.md | 78 | ||||
-rw-r--r-- | docs/PULL_REQUEST_TEMPLATE.md | 32 | ||||
-rw-r--r-- | docs/README.Android.md (renamed from docs/README.android) | 0 | ||||
-rw-r--r--[-rwxr-xr-x] | docs/README.Fedora.md (renamed from docs/README.fedora) | 0 | ||||
-rw-r--r-- | docs/README.FreeBSD.md (renamed from docs/README.FreeBSD) | 0 | ||||
-rw-r--r-- | docs/README.Linux.md (renamed from docs/README.linux) | 2 | ||||
-rw-r--r-- | docs/README.RaspberryPi.md (renamed from docs/README.raspberrypi) | 0 | ||||
-rw-r--r-- | docs/README.Ubuntu.md (renamed from docs/README.ubuntu) | 0 | ||||
-rw-r--r-- | docs/README.iOS.md (renamed from docs/README.ios.md) | 0 | ||||
-rw-r--r-- | docs/README.macOS.md (renamed from docs/README.osx.md) | 0 | ||||
-rw-r--r-- | docs/README.openSUSE.md (renamed from docs/README.opensuse) | 0 |
11 files changed, 111 insertions, 1 deletions
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md new file mode 100644 index 0000000000..ae70b6394d --- /dev/null +++ b/docs/CONTRIBUTING.md @@ -0,0 +1,78 @@ +### Introduction + +**Kodi** uses Github for development only, i.e. for *pull requests* and the review of such code. +**Do not open** an issue on Github for your questions or bug reports. +**Do not comment** on a *pull request* unless you are involved in the testing of such or have something meaningful to contribute. +Not familiar with git? Start by looking at Github's [collaborating pages](https://help.github.com/categories/collaborating/). + +#### Questions about Kodi? + +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 + +#### Issue or bug reports and discussions + +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*. + +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. + +For bug reports and related discussions, feature requests and all other support, please go to [Kodi community forum's](http://forum.kodi.tv/). + +#### Pull Requests + +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: + +- [Code guidelines](http://kodi.wiki/view/Official:Code_guidelines_and_formatting_conventions) +- [Submitting a patch](http://kodi.wiki/view/HOW-TO_submit_a_patch) +- [Kodi development](http://kodi.wiki/view/Development) + +###### General guidelines for creating pull requests: +- **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 these guidelines; it's the best way to get your work included in the project! + +- [Click here](https://github.com/xbmc/xbmc/fork/) to **fork Kodi** project, + and [configure the remote](https://help.github.com/articles/configuring-a-remote-for-a-fork/): + + ```bash + # Clone your fork of kodi's repo into the current directory in terminal + git clone git@github.com:<your github username>/xbmc.git kodi + # Navigate to the newly cloned directory + cd kodi + # Assign the original repo to a remote called "upstream" + git remote add upstream https://github.com/xbmc/xbmc.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 to 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. diff --git a/docs/PULL_REQUEST_TEMPLATE.md b/docs/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000000..ed898ddfba --- /dev/null +++ b/docs/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,32 @@ +<!--- Provide a general summary of your change in the Title above --> + +## Description +<!--- Describe your change in detail --> + +## Motivation and Context +<!--- Why is this change required? What problem does it solve? --> +<!--- If it fixes an open issue, please link to the issue here --> + +## How Has This Been Tested? +<!--- Please describe in detail how you tested your change --> +<!--- Include details of your testing environment, and the tests you ran to --> +<!--- see how your change affects other areas of the code, etc --> + +## Screenshots (if appropriate): + +## Types of change +<!--- What type of change does your code introduce? Put an `x` in all the boxes that apply like this: [X] --> +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] Improvement (non-breaking change which improves existing functionality) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to change) + +## Checklist: +<!--- Go over all the following points, and put an `x` in all the boxes that apply like this: [X] --> +<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> +- [ ] My code follows the [Code guidelines](https://codedocs.xyz/xbmc/xbmc/code_guidelines.html) of this project +- [ ] My change requires a change to the documentation, either Doxygen or wiki +- [ ] I have updated the documentation accordingly +- [ ] I have read the [CONTRIBUTING](https://github.com/xbmc/xbmc/blob/master/CONTRIBUTING.md) document +- [ ] I have added tests to cover my change +- [ ] All new and existing tests passed diff --git a/docs/README.android b/docs/README.Android.md index c2d04d154c..c2d04d154c 100644 --- a/docs/README.android +++ b/docs/README.Android.md diff --git a/docs/README.fedora b/docs/README.Fedora.md index 3321e05ff6..3321e05ff6 100755..100644 --- a/docs/README.fedora +++ b/docs/README.Fedora.md diff --git a/docs/README.FreeBSD b/docs/README.FreeBSD.md index 4d752c670a..4d752c670a 100644 --- a/docs/README.FreeBSD +++ b/docs/README.FreeBSD.md diff --git a/docs/README.linux b/docs/README.Linux.md index e7e722010c..cc517095f8 100644 --- a/docs/README.linux +++ b/docs/README.Linux.md @@ -100,7 +100,7 @@ Note: For developers and anyone else who compiles frequently it is recommended t For this, you need to specify the PPA in your apt sources. Please find them on the following wiki link: -Note: See README.ubuntu as well +Note: See README.Ubuntu.md as well http://kodi.wiki/index.php?title=Official_Ubuntu_PPA diff --git a/docs/README.raspberrypi b/docs/README.RaspberryPi.md index 9ed09a8eb8..9ed09a8eb8 100644 --- a/docs/README.raspberrypi +++ b/docs/README.RaspberryPi.md diff --git a/docs/README.ubuntu b/docs/README.Ubuntu.md index 75cba3846e..75cba3846e 100644 --- a/docs/README.ubuntu +++ b/docs/README.Ubuntu.md diff --git a/docs/README.ios.md b/docs/README.iOS.md index 28a6c9f616..28a6c9f616 100644 --- a/docs/README.ios.md +++ b/docs/README.iOS.md diff --git a/docs/README.osx.md b/docs/README.macOS.md index ba66ed95cc..ba66ed95cc 100644 --- a/docs/README.osx.md +++ b/docs/README.macOS.md diff --git a/docs/README.opensuse b/docs/README.openSUSE.md index 125db44f35..125db44f35 100644 --- a/docs/README.opensuse +++ b/docs/README.openSUSE.md |