Lines Matching +full:tests +full:- +full:coverage +full:- +full:reporting
8 -----------------
15 - The ``#get-help`` channel on our Discord chat:
17 - The mailing list [email protected] for long term discussion or larger
19 - Ask on `Stack Overflow`_. Search with Google first using:
25 Reporting issues
26 ----------------
30 - Describe what you expected to happen.
31 - If possible, include a `minimal reproducible example`_ to help us
34 - Describe what actually happened. Include the full traceback if there
36 - List your Python and Jinja versions. If possible, check if this
40 .. _minimal reproducible example: https://stackoverflow.com/help/minimal-reproducible-example
44 ------------------
54 - Use `Black`_ to format your code. This and other tools will run
55 automatically if you install `pre-commit`_ using the instructions
57 - Include tests if your patch adds or changes code. Make sure the test
59 - Update any relevant docs pages and docstrings. Docs pages and
61 - Add an entry in ``CHANGES.rst``. Use the same style as other
66 .. _pre-commit: https://pre-commit.com
72 - Download and install the `latest version of git`_.
73 - Configure git with your `username`_ and `email`_.
75 .. code-block:: text
77 $ git config --global user.name 'your name'
78 $ git config --global user.email 'your email'
80 - Make sure you have a `GitHub account`_.
81 - Fork Jinja to your GitHub account by clicking the `Fork`_ button.
82 - `Clone`_ the main repository locally.
84 .. code-block:: text
89 - Add your fork as a remote to push your work to. Replace
93 .. code-block:: text
97 - Create a virtualenv.
99 .. code-block:: text
101 $ python3 -m venv env
106 .. code-block:: text
110 - Install Jinja in editable mode with development dependencies.
112 .. code-block:: text
114 $ pip install -e . -r requirements/dev.txt
116 - Install the pre-commit hooks.
118 .. code-block:: text
120 $ pre-commit install
122 .. _latest version of git: https://git-scm.com/downloads
123 .. _username: https://help.github.com/en/articles/setting-your-username-in-git
124 .. _email: https://help.github.com/en/articles/setting-your-commit-email-address-in-git
127 .. _Clone: https://help.github.com/en/articles/fork-a-repo#step-2-create-a-local-clone-of-your-fork
133 - Create a branch to identify the issue you would like to work on. If
137 .. code-block:: text
140 $ git checkout -b your-branch-name origin/1.1.x
145 .. code-block:: text
148 $ git checkout -b your-branch-name origin/master
150 - Using your favorite editor, make your changes,
152 - Include tests that cover any code changes you make. Make sure the
153 test fails without your patch. Run the tests as described below.
154 - Push your commits to your fork on GitHub and
158 .. code-block:: text
160 $ git push --set-upstream fork your-branch-name
162 …_committing as you go: https://dont-be-afraid-to-commit.readthedocs.io/en/latest/git/commandlinegi…
163 .. _create a pull request: https://help.github.com/en/articles/creating-a-pull-request
166 Running the tests
171 .. code-block:: text
175 This runs the tests for the current environment, which is usually
180 .. code-block:: text
185 Running test coverage
188 Generating a report of lines that do not have test coverage can indicate
189 where to start contributing. Run ``pytest`` using ``coverage`` and
192 .. code-block:: text
194 $ pip install coverage
195 $ coverage run -m pytest
196 $ coverage html
200 Read more about `coverage <https://coverage.readthedocs.io>`__.
208 .. code-block:: text
215 Read more about `Sphinx <https://www.sphinx-doc.org/en/stable/>`__.