Skip to content

Update the project documentation with the testing guidelines #133

Open
@sergei-mironov

Description

@sergei-mironov

As a reminder I suggest updating the project docs with these:

  • each piece of logic being tested should live in a separate test function
  • only parametrize tests if the same logic is tested with different input values
  • prefer self-contained test functions with duplicated code if necessary (within reason)
  • avoid test function with too much logic, that is overly modular / parametrized, or makes heavy use of fixtures or other setup code

Originally posted by @dime10 in #98 (comment)

The closest known gudelines are https://github.com/PennyLaneAI/guidance-docs/blob/master/development/code-review.md#code-author-and-reviewers-checklist

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