Skip to content

Clarification on Adding Tests in Testing/Readme.md #259

@xavierbrgt

Description

@xavierbrgt

Hi,

I believe some parts of the README related to adding new tests could be made more explicit:

  • There is no clear mention that you need to add the test group in the desc.txt file, along with the generated pattern and reference files. While this can be inferred from the requirements, it should be explicitly stated in the relevant section.
  • The instructions for creating MyClass.h and MyClass.cpp are outdated. The correct location now depends on whether you are writing a test or a benchmark. Files should be placed in Include/Tests/MyClass.h or Include/Benchmarks/MyClass.h accordingly.
  • The README does not mention that the new test must be added to the list of builds in Makefile.txt.
  • There's also no mention of the folder used to generate patterns and reference files. PatternGeneration/Example.py could be link here to that effect. While the README explains how to launch the pattern generation, I think this folder and example should be referenced in the section about test creation as well.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions