Skip to content

guidelines for testset descriptions and structure #19625

Open
@Sacha0

Description

Guidelines for testset descriptions and structure would be useful. Some points potentially worth documenting:

Should testset descriptions fully describe the associated tests, or just provide a title and leave full description to an adjacent comment? If the former, should testset descriptions be complete sentences? If the latter, title case and comment placement conventions?

How fine grained should testsets be? Should they contain some minimal number of tests, or should an isolated test (e.g. a single-line issue spot test) have its own testset? Within a testset, should different subsets of tests be enclosed in their own testsets, or should they be demarcated by comments? Best!

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Assignees

No one assigned

    Labels

    HacktoberfestGood for Hacktoberfest participantsdocsThis change adds or pertains to documentationtestThis change adds or pertains to unit tests

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions