mirror of
https://github.com/getpelican/pelican.git
synced 2025-10-15 20:28:56 +02:00
Improve test coverage, docs, and .gitignore
This commit is contained in:
parent
8fd94ea025
commit
b77bb690e2
5 changed files with 73 additions and 3 deletions
|
|
@ -64,6 +64,20 @@ your bug fix or feature::
|
|||
Now you can make changes to Pelican, its documentation, and/or other aspects of
|
||||
the project.
|
||||
|
||||
Setting up git blame
|
||||
--------------------
|
||||
|
||||
``git blame`` annotates lines from a file with information about the pull request
|
||||
that last modified it. Sweeping shallow changes (like formatting) can make that
|
||||
information less useful, so we keep a list of such changes to be ignored. To set
|
||||
that up in your repository::
|
||||
|
||||
git config blame.ignoreRevsFile .git-blame-ignore-revs
|
||||
|
||||
For more information, see here_.
|
||||
|
||||
.. _here: https://www.michaelheap.com/git-ignore-rev/
|
||||
|
||||
Running the test suite
|
||||
----------------------
|
||||
|
||||
|
|
@ -108,6 +122,20 @@ environments.
|
|||
|
||||
.. _Tox: https://tox.readthedocs.io/en/latest/
|
||||
|
||||
Running a code coverage report
|
||||
------------------------------
|
||||
|
||||
The code is more likely to stay robust if it is tested.
|
||||
coverage_ is a library that measures how much of the code is tested.
|
||||
To run it::
|
||||
|
||||
invoke coverage
|
||||
open htmlcov/index.html
|
||||
|
||||
The HTML will show overall coverage, coverage per file, and even line-by-line coverage.
|
||||
|
||||
.. _coverage: https://github.com/nedbat/coveragepy
|
||||
|
||||
Building the docs
|
||||
-----------------
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue