pytest-dev / pytest-dev/pytest-html

Documentation should include sample reports

Open
#407 7 comments 5 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

help wanted
Dominant language
Python
Stars
779
Forks
260
PR merge metrics
No merged PRs in 30d

Description

We should really produce some sample reports that exemplifies features and include them in the documentation.

This will allow us to easily test the visual effects of various changes that we are doing and compare them with previous version.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the existing documentation and report-generation examples first; the issue does not name specific files or tests. Define representative sample reports covering the documented features, add them to the documentation, and verify they support visual comparison with previous versions.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, testing-qa
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.