approvals / approvals/ApprovalTests.Python
I want a picture of the approvaltests configuration options
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 212
- Forks
- 56
- Avg merge
- 1m
- Merged PRs (30d)
- 1
Description
Almost everything in approvaltests is configurable.
When I want to change something though, sometimes it's hard for me to form a picture in my brain of what configuration option I need to change it. It's also hard to scroll through all of the documentation to figure out what I need to change to get the behaviour I want.
I want a real world example to build the pictures off of.
I want a screenshot of a simple approval test that verifies an object.
I want a screenshot of the object and it's str method
I want a screenshot of the received and approved files
I want arrows drawing the connections between all 3 files
I want boxes drawn around the parts that can change (test setup or input like printers, File name, file location, file contents, actions to approve things)
I want those boxes to have a connection to a larger box with all of the current built-in options for behaviours
I want those boxes to have a picture of how to swap the default configuration for an alternative (including import statements).
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing ApprovalTests documentation and the current built-in configuration options, then identify a simple approval test that verifies an object. Done means a visual guide includes the requested screenshots, connections, configurable areas, built-in behaviours, and alternative configuration examples with imports.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, testing
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100