Test Case Naming Conventions
Open
Nobody has claimed this yet.
community
GCC
important
plan
- Dominant language
- C++
- Stars
- 2.9k
- Forks
- 230
- Avg merge
- 19h 55m
- Merged PRs (30d)
- 67
Description
At present, I have been creating test cases like generics1,2,3,4 etc, which is not helpful in terms of figuring out what they are testing. It has been ok for now since test cases are small.
Below is a simple naming convention that might help, but I wish to solicit feedback first.
- If its a github issue: name the test case issue-number.rs
- Else name the test case with language-feature.rs but contain a comment at the start of the test case what this test case covers.
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
Review the existing test cases named generics1,2,3,4 and the proposed issue-number.rs or language-feature.rs convention, including a leading coverage comment. Done means an agreed convention is documented and applied, but this issue currently asks for feedback rather than naming a concrete implementation scope.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- compilers, testing
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100