Mercurial > repos > vimalkumarvelayudhan > riboplot

comparison docs/contributing.rst @ 14:628f82e72d72

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Version as released on PyPI 0.1.0
author Vimalkumar Velayudhan <vimal@biotechcoder.com>
date Wed, 26 Aug 2015 16:37:10 +0100
parents 096c6bbf4a04
children ef39290c19af
comparison
equal deleted inserted replaced
13:8a87a2c44d09 14:628f82e72d72
1 ============ 1 .. include:: ../CONTRIBUTING.rst
2 Contributing
3 ============
4
5 Contributions are welcome, and they are greatly appreciated! Every
6 little bit helps, and credit will always be given.
7
8 You can contribute in many ways:
9
10 Types of Contributions
11 ----------------------
12
13 Report Bugs
14 ~~~~~~~~~~~
15
16 Report bugs at https://github.com/vimalkumarvelayudhan/riboplot/issues.
17
18 If 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
24 Fix Bugs
25 ~~~~~~~~
26
27 Look through the GitHub issues for bugs. Anything tagged with "bug"
28 is open to whoever wants to implement it.
29
30 Implement Features
31 ~~~~~~~~~~~~~~~~~~
32
33 Look through the GitHub issues for features. Anything tagged with "feature"
34 is open to whoever wants to implement it.
35
36 Write Documentation
37 ~~~~~~~~~~~~~~~~~~~
38
39 RiboPlot could always use more documentation, whether as part of the
40 official RiboPlot docs, in docstrings, or even on the web in blog posts,
41 articles, and such.
42
43 Submit Feedback
44 ~~~~~~~~~~~~~~~
45
46 The best way to send feedback is to file an issue at https://github.com/vimalkumarvelayudhan/riboplot/issues.
47
48 If you are proposing a feature:
49
50 * Explain in detail how it would work.
51 * Keep the scope as narrow as possible, to make it easier to implement.
52 * Remember that this is a volunteer-driven project, and that contributions
53 are welcome :)
54
55 Get Started!
56 ------------
57
58 Ready to contribute? Here's how to set up `riboplot` for local development.
59
60 1. Fork the `riboplot` repo on GitHub.
61 2. Clone your fork locally::
62
63 $ git clone git@github.com:your_name_here/riboplot.git
64
65 3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
66
67 $ mkvirtualenv riboplot
68 $ cd riboplot/
69 $ python setup.py develop
70
71 4. Create a branch for local development::
72
73 $ git checkout -b name-of-your-bugfix-or-feature
74
75 Now you can make your changes locally.
76
77 5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox::
78
79 $ flake8 riboplot tests
80 $ python setup.py test
81 $ tox
82
83 To get flake8 and tox, just pip install them into your virtualenv.
84
85 6. Commit your changes and push your branch to GitHub::
86
87 $ git add .
88 $ git commit -m "Your detailed description of your changes."
89 $ git push origin name-of-your-bugfix-or-feature
90
91 7. Submit a pull request through the GitHub website.
92
93 Pull Request Guidelines
94 -----------------------
95
96 Before you submit a pull request, check that it meets these guidelines:
97
98 1. The pull request should include tests.
99 2. If the pull request adds functionality, the docs should be updated. Put
100 your new functionality into a function with a docstring, and add the
101 feature to the list in README.rst.
102 3. The pull request should work for Python 2.6, 2.7, 3.3, and 3.4, and for PyPy. Check
103 https://travis-ci.org/vimalkumarvelayudhan/riboplot/pull_requests
104 and make sure that the tests pass for all supported Python versions.
105
106 Tips
107 ----
108
109 To run a subset of tests::
110
111 $ python -m unittest tests.test_riboplot