|
1 | | -************ |
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 the |
17 | | -`GitHub issue tracker <https://github.com/transcode-de/durga/issues>`_. |
18 | | - |
19 | | -If you are reporting a bug, please include: |
20 | | - |
21 | | -* Your operating system name and version. |
22 | | -* Any details about your local setup that might be helpful in troubleshooting. |
23 | | -* Detailed steps to reproduce the bug. |
24 | | - |
25 | | -Fix Bugs |
26 | | --------- |
27 | | - |
28 | | -Look through the GitHub issues for bugs. Anything tagged with "bug" |
29 | | -is open to whoever wants to implement it. |
30 | | - |
31 | | -Implement Features |
32 | | ------------------- |
33 | | - |
34 | | -Look through the GitHub issues for features. Anything tagged with |
35 | | -"feature" is open to whoever wants to implement it. |
36 | | - |
37 | | -Write Documentation |
38 | | -------------------- |
39 | | - |
40 | | -Durga could always use more documentation, whether as part of the |
41 | | -official Durga docs, in docstrings, or even on the web in blog posts, |
42 | | -articles, and such. |
43 | | - |
44 | | -Submit Feedback |
45 | | ---------------- |
46 | | - |
47 | | -The best way to send feedback is to file an issue at the |
48 | | -`GitHub issue tracker <https://github.com/transcode-de/durga/issues>`_. |
49 | | - |
50 | | -If you are proposing a feature: |
51 | | - |
52 | | -* Explain in detail how it would work. |
53 | | -* Keep the scope as narrow as possible, to make it easier to implement. |
54 | | -* Remember that this is a volunteer-driven project, and that |
55 | | - contributions are welcome :) |
56 | | - |
57 | | -Get Started! |
58 | | -============ |
59 | | - |
60 | | -Ready to contribute? Here's how to set up `durga` for local development. |
61 | | - |
62 | | -1. Fork the `durga` repo on GitHub. |
63 | | -2. Clone your fork locally:: |
64 | | - |
65 | | - $ git clone [email protected]:your_name_here/durga.git |
66 | | - |
67 | | -3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:: |
68 | | - |
69 | | - $ mkvirtualenv durga |
70 | | - $ cd durga |
71 | | - $ make develop |
72 | | - |
73 | | -4. Create a branch for local development:: |
74 | | - |
75 | | - $ git checkout -b name-of-your-bugfix-or-feature |
76 | | - |
77 | | - Now you can make your changes locally. |
78 | | - |
79 | | -5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:: |
80 | | - |
81 | | - $ make test |
82 | | - $ make test-all |
83 | | - |
84 | | -6. Commit your changes and push your branch to GitHub:: |
85 | | - |
86 | | - $ git add . |
87 | | - $ git commit -m "Your detailed description of your changes." |
88 | | - $ git push origin name-of-your-bugfix-or-feature |
89 | | - |
90 | | -7. Submit a pull request through the GitHub website. |
91 | | - |
92 | | -Pull Request Guidelines |
93 | | -======================= |
94 | | - |
95 | | -Before you submit a pull request, check that it meets these guidelines: |
96 | | - |
97 | | -1. The pull request should include tests. |
98 | | -2. If the pull request adds functionality, the docs should be updated. Put |
99 | | - your new functionality into a function with a docstring, and add the |
100 | | - feature to the list in :file:`README.rst`. |
101 | | -3. The pull request should work for Python 2.7 and 3.4. Check |
102 | | - `Travis CI <https://travis-ci.org/transcode-de/durga/pull_requests>`_ |
103 | | - and make sure that the tests pass for all supported Python versions. |
104 | | - |
105 | | -Tips |
106 | | -==== |
107 | | - |
108 | | -To run a subset of tests:: |
109 | | - |
110 | | - $ make test TEST_ARGS='-k <EXPRESSION>' |
| 1 | +.. include:: ../CONTRIBUTING.rst |
0 commit comments