1============ 2Contributing 3============ 4 5Contributions are welcome, and they are greatly appreciated! Every 6little bit helps, and credit will always be given. 7 8You can contribute in many ways: 9 10Types of Contributions 11---------------------- 12 13Report Bugs 14~~~~~~~~~~~ 15 16Report bugs at https://github.com/chrippa/livestreamer/issues. 17 18If you are reporting a bug, please include: 19 20* Your operating system name and version. 21* Any details about your local setup that might be helpful in troubleshooting. 22* Detailed steps to reproduce the bug. 23 24Fix Bugs 25~~~~~~~~ 26 27Look through the GitHub issues for bugs. Anything tagged with "bug" 28is open to whoever wants to implement it. 29 30Implement Features 31~~~~~~~~~~~~~~~~~~ 32 33Look through the GitHub issues for features. Anything tagged with "feature" 34is open to whoever wants to implement it. 35 36Adding Plugins 37~~~~~~~~~~~~~~ 38 39Livestreamer can always use more plugins. Look through the GitHub issues 40if you are looking for something to implement. 41 42There is no plugin documentation at the moment, but look at the existing 43plugins to get an idea of how it works. 44 45Write Documentation 46~~~~~~~~~~~~~~~~~~~ 47 48Livestreamer could always use more documentation, whether as part of the 49official Livestreamer docs, in docstrings, or even on the web in blog posts, 50articles, and such. 51 52Submit Feedback 53~~~~~~~~~~~~~~~ 54 55The best way to send feedback is to file an issue at https://github.com/chrippa/livestreamer/issues. 56 57If you are proposing a feature: 58 59* Explain in detail how it would work. 60* Keep the scope as narrow as possible, to make it easier to implement. 61* Remember that this is a volunteer-driven project, and that contributions 62 are welcome :) 63 64Get Started! 65------------ 66 67Ready to contribute? Here's how to set up `livestreamer` for local development. 68 691. Fork the `livestreamer` repo on GitHub. 702. Clone your fork locally:: 71 72 $ git clone git@github.com:your_name_here/livestreamer.git 73 743. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:: 75 76 $ mkvirtualenv livestreamer 77 $ cd livestreamer/ 78 $ python setup.py develop 79 804. Create a branch for local development:: 81 82 $ git checkout -b name-of-your-bugfix-or-feature 83 84 Now you can make your changes locally. 85 865. When you're done making changes, check that your changes pass the 87tests, including testing other Python versions with tox:: 88 89 $ python setup.py test 90 $ tox 91 92 To get tox, just pip install it into your virtualenv. 93 946. Commit your changes and push your branch to GitHub:: 95 96 $ git add . 97 $ git commit -m "Your detailed description of your changes." 98 $ git push origin name-of-your-bugfix-or-feature 99 1007. Submit a pull request through the GitHub website. 101 102Pull Request Guidelines 103----------------------- 104 105Before you submit a pull request, check that it meets these guidelines: 106 1071. The pull request should include tests if it's a core feature. 1082. If the pull request adds functionality, the docs should be updated. 1093. When creating a pull request, make sure it's on the correct branch. 110 These branches are currently used: 111 112 - master: Only critical fixes that needs to be released ASAP. 113 - develop: Everything else. 114 1154. The pull request should work for Python 2.6, 2.7, and 3.3, and for PyPy. Check 116 https://travis-ci.org/chrippa/livestreamer/pull_requests 117 and make sure that the tests pass for all supported Python versions. 118 119