Lines Matching +full:test +full:- +full:docs
8 -----------------
15 - The ``#get-help`` channel on our Discord chat:
17 - The mailing list flask@python.org for long term discussion or larger
19 - Ask on `Stack Overflow`_. Search with Google first using:
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 MarkupSafe 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 MarkupSafe 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 - Upgrade pip and setuptools.
112 .. code-block:: text
114 $ python -m pip install --upgrade pip setuptools
116 - Install the development dependencies, then install MarkupSafe in
119 .. code-block:: text
121 $ pip install -r requirements/dev.txt && pip install -e .
123 - Install the pre-commit hooks.
125 .. code-block:: text
127 $ pre-commit install
129 .. _latest version of git: https://git-scm.com/downloads
130 .. _username: https://docs.github.com/en/github/using-git/setting-your-username-in-git
131 .. _email: https://docs.github.com/en/github/setting-up-and-managing-your-github-user-account/setti…
134 .. _Clone: https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#step-2-create-…
140 - Create a branch to identify the issue you would like to work on. If
144 .. code-block:: text
147 $ git checkout -b your-branch-name origin/2.0.x
152 .. code-block:: text
155 $ git checkout -b your-branch-name origin/main
157 - Using your favorite editor, make your changes,
159 - Include tests that cover any code changes you make. Make sure the
160 test fails without your patch. Run the tests as described below.
161 - Push your commits to your fork on GitHub and
165 .. code-block:: text
167 $ git push --set-upstream fork your-branch-name
169 …_committing as you go: https://dont-be-afraid-to-commit.readthedocs.io/en/latest/git/commandlinegi…
170 … _create a pull request: https://docs.github.com/en/github/collaborating-with-issues-and-pull-requ…
176 Run the basic test suite with pytest.
178 .. code-block:: text
184 request. You can run the full test suite with tox if you don't want to
187 .. code-block:: text
192 Running test coverage
195 Generating a report of lines that do not have test coverage can indicate
199 .. code-block:: text
202 $ coverage run -m pytest
210 Building the docs
213 Build the docs in the ``docs`` directory using Sphinx.
215 .. code-block:: text
217 $ cd docs
220 Open ``_build/html/index.html`` in your browser to view the docs.
222 Read more about `Sphinx <https://www.sphinx-doc.org/en/stable/>`__.