tests: Should we follow stylistic conventions more consistently?
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 11.1k
- Forks
- 1.7k
- Avg merge
- 4d 15h
- Merged PRs (30d)
- 22
Description
In test code, we've historically been less strict about enforcing global stylistic conventions. We generally expect consistency within a test, but different tests vary in:
using namespace std;versusstd::qualification (there are a relatively small number of tests where this makes a real difference)const TversusT constclassversustypenamein template parameters
Historically, this seemed reasonable because it allowed each maintainer to write test code in their most preferred style, and we generally don't treat the test code as a unified whole (we generally write a test, and then it stays unchanged unless we need to fix/extend it). However, this makes things somewhat confusing for contributors, since we don't have consistent precedents to follow.
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
No files, tests, or entry points are identified in the issue. Review the issue discussion first to determine whether a consistent convention is wanted and which stylistic choices are in scope; done requires an explicit decision and an identified set of test changes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- testing-qa
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100