ukaea / ukaea/PROCESS

Strategy for updating unit tests

Open
#3,927 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Testing
Dominant language
Python
Stars
71
Forks
27
Avg merge
2d 18h
Merged PRs (30d)
33

Description

How unit tests should be updated (particularly going from automatically-generated to human-created) should be clearly explained to the group, and added to the docs. Monkeypatched arrays particularly cause developers headaches, although much of this should be improved with the new data structure.

Contributor guide

Open the contributing guide

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

The issue names no files, tests, or entry points, so first identify the existing unit-test documentation and examples covering generated versus human-created tests. Review how monkeypatched arrays and the new data structure are currently described. Done means the documentation clearly explains the update strategy and addresses those sources of confusion.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.