[SERVER-64790] Require jstest tags to be documented Created: 22/Mar/22  Updated: 23/Oct/23

Status: Open
Project: Core Server
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Major - P3
Reporter: Esha Maharishi (Inactive) Assignee: [DO NOT ASSIGN] Backlog - DevProd Correctness
Resolution: Unresolved Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Assigned Teams:
Correctness
Participants:

 Description   

This ticket is to require tags to be documented, e.g. by having a "tags documentation" file and rejecting a jstest that has an undocumented tag.

Each test should have a comment above each tag that explains why it's using the tag, but that comment shouldn't need to explain what the tag is for. For example, a test could have "requires_persistence" with comment "This test restarts the tenant migration donor primary", and "requires_persistence" could be documented as "excludes the test from running with the inMemory storage engine."

This would be especially helpful because we often write new jstests by copying old ones, and it's hard to tell if we should carry over all the existing tags.



 Comments   
Comment by Matt Broadstone [ 17/Aug/23 ]

Moved to SDP's backlog. Esha is no longer at the company, but you can reach out to me for more information.

Generated at Thu Feb 08 06:01:09 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.