Mercurial > repos > vimalkumarvelayudhan > riboplot
diff docs/contributing.rst @ 7:096c6bbf4a04
Bugfix: (ribocounts) Read length was sent as rnafile argument in check_optional_arguments
author | Vimalkumar Velayudhan <vimal@biotechcoder.com> |
---|---|
date | Thu, 13 Aug 2015 15:03:20 +0100 |
parents | cef780bcce01 |
children | 628f82e72d72 |
line wrap: on
line diff
--- a/docs/contributing.rst Wed Aug 12 16:28:43 2015 +0100 +++ b/docs/contributing.rst Thu Aug 13 15:03:20 2015 +0100 @@ -1,1 +1,111 @@ -../CONTRIBUTING.rst \ No newline at end of file +============ +Contributing +============ + +Contributions are welcome, and they are greatly appreciated! Every +little bit helps, and credit will always be given. + +You can contribute in many ways: + +Types of Contributions +---------------------- + +Report Bugs +~~~~~~~~~~~ + +Report bugs at https://github.com/vimalkumarvelayudhan/riboplot/issues. + +If you are reporting a bug, please include: + +* Your operating system name and version. +* Any details about your local setup that might be helpful in troubleshooting. +* Detailed steps to reproduce the bug. + +Fix Bugs +~~~~~~~~ + +Look through the GitHub issues for bugs. Anything tagged with "bug" +is open to whoever wants to implement it. + +Implement Features +~~~~~~~~~~~~~~~~~~ + +Look through the GitHub issues for features. Anything tagged with "feature" +is open to whoever wants to implement it. + +Write Documentation +~~~~~~~~~~~~~~~~~~~ + +RiboPlot could always use more documentation, whether as part of the +official RiboPlot docs, in docstrings, or even on the web in blog posts, +articles, and such. + +Submit Feedback +~~~~~~~~~~~~~~~ + +The best way to send feedback is to file an issue at https://github.com/vimalkumarvelayudhan/riboplot/issues. + +If you are proposing a feature: + +* Explain in detail how it would work. +* Keep the scope as narrow as possible, to make it easier to implement. +* Remember that this is a volunteer-driven project, and that contributions + are welcome :) + +Get Started! +------------ + +Ready to contribute? Here's how to set up `riboplot` for local development. + +1. Fork the `riboplot` repo on GitHub. +2. Clone your fork locally:: + + $ git clone git@github.com:your_name_here/riboplot.git + +3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:: + + $ mkvirtualenv riboplot + $ cd riboplot/ + $ python setup.py develop + +4. Create a branch for local development:: + + $ git checkout -b name-of-your-bugfix-or-feature + + Now you can make your changes locally. + +5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:: + + $ flake8 riboplot tests + $ python setup.py test + $ tox + + To get flake8 and tox, just pip install them into your virtualenv. + +6. Commit your changes and push your branch to GitHub:: + + $ git add . + $ git commit -m "Your detailed description of your changes." + $ git push origin name-of-your-bugfix-or-feature + +7. Submit a pull request through the GitHub website. + +Pull Request Guidelines +----------------------- + +Before you submit a pull request, check that it meets these guidelines: + +1. The pull request should include tests. +2. If the pull request adds functionality, the docs should be updated. Put + your new functionality into a function with a docstring, and add the + feature to the list in README.rst. +3. The pull request should work for Python 2.6, 2.7, 3.3, and 3.4, and for PyPy. Check + https://travis-ci.org/vimalkumarvelayudhan/riboplot/pull_requests + and make sure that the tests pass for all supported Python versions. + +Tips +---- + +To run a subset of tests:: + + $ python -m unittest tests.test_riboplot \ No newline at end of file