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

docs: add default structure for all test cases #1872

Open
wants to merge 20 commits into
base: main
Choose a base branch
from

Conversation

AlexandraTrifan
Copy link
Contributor

@AlexandraTrifan AlexandraTrifan commented Jan 10, 2025

Below are some recommendations for formatting documentation files so that we all have a similar template.

User Guide

  • Use the .. note:: rst label.
  • The information within the notes should follow the format:
    • User guide: :ref:My plugin user guide<doc_reference>.

Setup

  • Name: Setup environment
  • Use the same heading level as for the tests.
  • Each setup should have a label so that it can be referenced from the tests.
  • The names of the setups should be bold.
  • The steps within the setup should be written as a bulleted list.

Test Labels

  • All test labels should be bold (UID, Description, Preconditions...). Also the Expected result: label should be bold.
  • Expected result
    • If there is only one expected result, it must be written inline, otherwise all expected results must be written as a bulleted list.
  • The UID and Description should be written inline with the labels, without bullets.
  • Each test must contains the Result label
    • Result: PASS/FAIL

Preconditions

  • Use a bulleted list.
  • References to setups.
  • OS label
    • use capital letters for the label name
    • options: ANY/ALL/a, list, of, operating, systems
      • Windows, Linux-x86_64, Linux-arm64, Linux-arm32, macOS

Steps

  • Use a numbered list.
  • Use a bullet for the Expected result.

Prerequisites and Dependencies

  • If they are generic, they can be written under the Setup environment section.
  • If they are not generic, they can be written individually, for each test.

Highlight field names

  • Use bold for button names, field names, etc.

NOTES

  • All the test cases PRs should be merged here first.
  • When all of them are ready to go, we can get this branch to main.
  • todo: change default doc branch to main instead of dev

@AlexandraTrifan AlexandraTrifan force-pushed the main-doc-test-case-struct branch from 5ff7d90 to 24c97b1 Compare January 10, 2025 15:18
andreidanila1 and others added 9 commits January 13, 2025 10:38
The tests cover: home page, add page, connection flow, emu and device
interaction.

Signed-off-by: andreidanila1 <[email protected]>
The tests cover all the PQM instruments.

Signed-off-by: andreidanila1 <[email protected]>
Signed-off-by: IonutMuthi <[email protected]>
Signed-off-by: IonutMuthi <[email protected]>
@AlexandraTrifan AlexandraTrifan marked this pull request as ready for review January 23, 2025 11:26
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.

5 participants