What is the problem this feature will solve?
doc/contributing/writing-tests.md says tests should start with a brief comment describing intent, but many tests don't have such comments. In a large test file a 1-2 sentence header helps a lot with readability.
What is the feature you are proposing to solve the problem?
- Add an ESLint rule for test files that requires a brief top of file description comment explaining what the test is checking.
- Roll it out gradually? (e.g, warn first or new tests first)
What alternatives have you considered?
Keep this as documentation only suggestion
What is the problem this feature will solve?
doc/contributing/writing-tests.md says tests should start with a brief comment describing intent, but many tests don't have such comments. In a large test file a 1-2 sentence header helps a lot with readability.
What is the feature you are proposing to solve the problem?
What alternatives have you considered?
Keep this as documentation only suggestion