Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(skeleton): add testing documentation structure #69

Merged
merged 2 commits into from
Oct 13, 2023

Conversation

Diogo21Costa
Copy link
Member

PR Description

The document is organized into six main sections:

  1. Introduction: Briefly describes the core components of the test framework.

  2. Test Framework Overview: Explores the interaction of core components and deployment of tests.

  3. Practical Guide: Provides practical guidelines for setting up the test framework, including four subtopics:

    • Directory Structure: Explains how to set up the test framework and integrate it with the module under test.
    • Test Configuration File: Describes how developers can configure a battery of tests.
    • Tests Definition: Offers a detailed description of how to write tests.
    • How to Use: Provides a detailed guide on setting up the entry point for tests in the module under test and utilizing the Python API.
  4. For Advanced Users: Targets users seeking an in-depth understanding of the framework's workflow and how to create new recipes for various test scenarios.

  5. Extending Framework Tests: Offers guidelines on expanding the framework of tests, covering:

    • Contributing to Tests Repository: Explores how to extend the tests repository of the test framework.
  6. Demos: Provides practical examples of how the test framework can be configured to deploy tests using QEMU.

Checklist:

  • The changes follows the documentation guidelines described in here.
  • The changes generate no new warnings when building the project. If so, I have justified above.
  • I have run the CI checkers before submitting the PR to avoid unnecessary runs of the workflow.

Do you have any suggestions regarding the structure of the documentation?

source/development/testing.rst Outdated Show resolved Hide resolved
@danielRep danielRep self-assigned this Sep 29, 2023
@danielRep danielRep merged commit cabeb59 into wip/testing Oct 13, 2023
4 checks passed
@danielRep danielRep deleted the feat/testing-skeleton branch October 13, 2023 10:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants