|
1 | 1 | .. _contributing:
|
2 | 2 |
|
3 |
| -How to contribute |
4 |
| -================= |
5 |
| - |
6 |
| -All contributions are greatly appreciated! |
7 |
| - |
8 |
| -How to report issues |
9 |
| -~~~~~~~~~~~~~~~~~~~~ |
10 |
| - |
11 |
| -Facilitating the work of potential contributors is recommended since it |
12 |
| -increases the likelihood of your issue being solved quickly. The few extra |
13 |
| -steps listed below will help clarify problems you might be facing: |
14 |
| - |
15 |
| -- Include a `minimal reproducible example`_ when possible. |
16 |
| -- Describe the expected behaviour and what actually happened including a full |
17 |
| - trace-back in case of exceptions. |
18 |
| -- Make sure to list details about your environment, such as your platform, |
19 |
| - versions of pytest, pytest-flask and python release. |
20 |
| - |
21 |
| -Also, it's important to check the current open issues for similar reports |
22 |
| -in order to avoid duplicates. |
23 |
| - |
24 |
| -.. _minimal reproducible example: https://stackoverflow.com/help/minimal-reproducible-example |
25 |
| - |
26 |
| -Setting up your development environment |
27 |
| -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
28 |
| - |
29 |
| -- Fork pytest-flask to your GitHub account by clicking the `Fork`_ button. |
30 |
| -- `Clone`_ the main repository (not your fork) to your local machine. |
31 |
| - |
32 |
| - .. code-block:: text |
33 |
| -
|
34 |
| - $ git clone https://github.com/pytest-dev/pytest-flask |
35 |
| - $ cd pytest-flask |
36 |
| -
|
37 |
| -- Add your fork as a remote to push your contributions.Replace |
38 |
| - ``{username}`` with your username. |
39 |
| - |
40 |
| - .. code-block:: text |
41 |
| -
|
42 |
| - $ git remote add fork https://github.com/{username}/pytest-flask |
43 |
| -
|
44 |
| -- Using `Tox`_, create a virtual environment and install pytest-flask in editable mode with development dependencies. |
45 |
| - |
46 |
| - .. code-block:: text |
47 |
| -
|
48 |
| - $ tox -e dev |
49 |
| - $ source venv/bin/activate |
50 |
| -
|
51 |
| -- Install pre-commit hooks |
52 |
| - |
53 |
| - .. code-block:: text |
54 |
| -
|
55 |
| - $ pre-commit install |
56 |
| -
|
57 |
| -.. _Fork: https://github.com/pytest-dev/pytest-flask/fork |
58 |
| -.. _Clone: https://docs.github.com/en/get-started/quickstart/fork-a-repo#step-2-create-a-local-clone-of-your-fork |
59 |
| -.. _Tox: https://tox.readthedocs.io/en/latest/ |
60 |
| - |
61 |
| -Start Coding |
62 |
| -~~~~~~~~~~~~ |
63 |
| - |
64 |
| -- Create a new branch to identify what feature you are working on. |
65 |
| - |
66 |
| - .. code-block:: text |
67 |
| -
|
68 |
| - $ git fetch origin |
69 |
| - $ git checkout -b your-branch-name origin/master |
70 |
| -
|
71 |
| -- Make your changes |
72 |
| -- Include tests that cover any code changes you make and run them |
73 |
| - as described below. |
74 |
| -- Push your changes to your fork. |
75 |
| - `create a pull request`_ describing your changes. |
76 |
| - |
77 |
| - .. code-block:: text |
78 |
| -
|
79 |
| - $ git push --set-upstream fork your-branch-name |
80 |
| -
|
81 |
| -.. _create a pull request: https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request |
82 |
| - |
83 |
| -How to run tests |
84 |
| -~~~~~~~~~~~~~~~~ |
85 |
| - |
86 |
| -You can run the test suite for the current environment with |
87 |
| - |
88 |
| - .. code-block:: text |
89 |
| -
|
90 |
| - $ pytest |
91 |
| -
|
92 |
| -To run the full test suite for all supported python versions |
93 |
| - |
94 |
| - .. code-block:: text |
95 |
| -
|
96 |
| - $ tox |
97 |
| -
|
98 |
| -Obs. CI will run tox when you submit your pull request, so this is optional. |
99 |
| - |
100 |
| -Checking Test Coverage |
101 |
| -~~~~~~~~~~~~~~~~~~~~~~~ |
102 |
| - |
103 |
| -To get a complete report of code sections not being touched by the |
104 |
| -test suite run ``pytest`` using ``coverage``. |
105 |
| - |
106 |
| -.. code-block:: text |
107 |
| -
|
108 |
| - $ coverage run -m pytest |
109 |
| - $ coverage html |
110 |
| -
|
111 |
| -Open ``htmlcov/index.html`` in your browser. |
112 |
| - |
113 |
| -More about coverage `here <https://coverage.readthedocs.io>`__. |
| 3 | +.. include:: ../CONTRIBUTING.rst |
0 commit comments