Test modules in `twisted/test/` for which preferred replacements already exist must be marked as such
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 6k
- Forks
- 1.2k
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 10
Description
| @exarkun reported | |
|---|---|
| Trac ID | trac#5452 |
| Type | enhancement |
| Created | 2012-01-15 14:55:33Z |
For a while we've been moving away from having so many tests in twisted/test/. This started with the subproject split and proceeded from there. It's sensible to try to keep unit tests close to implementation. So tests for twisted/python/reflect.py make more sense in twisted/python/test/test_reflect.py than in twisted/test/test_reflect.py. Splitting things up also helps avoid ugly namespace collisions (or rather, the ugly results of having to resolve such collisions).
In some cases, we have started adding new tests in a new location while leaving many old tests in the old location, though. The old location is an attractive nuisance to new contributors who don't understand what's going on, and reasonably believe that it's a good idea to add new TCP-related unit tests to twisted/test/test_tcp.py.
We need to identify all test modules in twisted/test/ which are not supposed to have new tests added to them and mark them with information pointing to the preferred location for such tests.
Hopefully this will guide contributors to adding tests in the correct location.
Searchable metadata
trac-id__5452 5452
type__enhancement enhancement
reporter__exarkun exarkun
priority__normal normal
milestone__
branch__
branch_author__
status__new new
resolution__None None
component__core core
keywords__
time__1326639333000000 1326639333000000
changetime__1328453270000000 1328453270000000
version__None None
owner__
cc__thijs
Contributor guide
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 inventorying test modules under twisted/test/ and compare them with the preferred locations described in the issue, such as twisted/python/test/test_reflect.py. Identify each module that should no longer receive new tests and determine how its preferred replacement should be recorded. Done means every applicable module points contributors to the correct location.
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