tests/test_check_contributors.py is a 740-line file for four modules

Open Beginner friendly
#1,327 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
82/100
Issue type
Refactor
Clarity
Clearly specified
Activity status
Active
Tech stack
python
Domain
testing

Research direction

Start with tests/test_check_contributors.py and inspect its test groups and shared fixtures (DOC, PRS, STUB_DOC, and run). Split the tests across the modules named in the issue and move shared documents into tests/contributors_helpers.py. Run the same tests; done means every test file is under 300 lines and the tests still pass.

Written by the indexing model from the issue text.

Description

enhancement good first issue testing

Where: tests/test_check_contributors.py.

Current gap: After the script was split (#1319) into contributors_entries.py, contributors_write.py, contributors_github.py and check_contributors.py, all of its tests still sit in one 742-line file with the fixtures (DOC, PRS, STUB_DOC, run) shared at the top.

Suggested approach: Split it per module (entries and checks, rewriting and stubs, GitHub wrappers and the command line) with the shared documents in a tests/contributors_helpers.py.

Done when: no test file is over 300 lines and the same tests pass.

Dominant language
HTML
Stars
47
Forks
45
Avg merge
2h 49m
Merged PRs (30d)
69

Getting set up

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.

More from yakew7/Fair-Code

All issues in yakew7/Fair-Code

Similar issues

More Testing & QA issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.