matrix-org / matrix-org/complement
Consider using a single file-naming scheme and test grouping methodology
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 99
- Forks
- 72
- Avg merge
- 4d 1h
- Merged PRs (30d)
- 8
Description
Currently, while browsing the test repository, i find it difficult to navigate to tests i expect to exist, and/or not to exist, as the file naming scheme (and test grouping) seems to be all over the place.
I think it'll be worth it (for organisational purposes) to organise files and scope tests such that someone new coming into the repository can find their way and discover related tests better.
---
Some current complaints and notes are that some files seem to inherit sytest's vague naming scheme (`apidoc`, `federation`, etc.), some simply document and test MSCs, and some restrict themselves to very narrow scopes (`account_change_password_pushers_test.go`)
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 surveying the test repository's existing filenames and grouping patterns, including examples such as apidoc, federation, MSC-related tests, and account_change_password_pushers_test.go. The work is done when a consistent naming and test-grouping approach is agreed and applied across the affected tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- developer-experience, testing
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100