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 details related to testing in docs #2596

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

kmr-srbh
Copy link
Contributor

@kmr-srbh kmr-srbh commented Mar 11, 2024

The problem

The current information related to testing is confusing and unclear. It does not guide one on what the various types of tests are and how to write and register them.

The fix

This PR does the following things:

  • Add details about the various types of tests, where they are located and why they are required.
  • Add details about the procedure to write integration tests and update references.
  • Add details about the procedure to write error tests and update references.

Minor: Fix indentation in the README and installation docs for visual clarity.

Planned:

  • Add details on compile time tests and their requirement. (guidance required)
  • Add details on troubleshooting failing CI tests.

@kmr-srbh
Copy link
Contributor Author

@Shaikh-Ubaid @Thirumalai-Shaktivel I request you to check this data and verify the correctness. I request you to provide me more information regarding compile time tests so that the section can be complete.

@kmr-srbh kmr-srbh changed the title Add details related to testing in docs Docs: Add details related to testing in docs Mar 11, 2024
Copy link
Collaborator

@Shaikh-Ubaid Shaikh-Ubaid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like there are many indentation changes. It is hard for me to see/understand what changes were made.

@kmr-srbh
Copy link
Contributor Author

@Shaikh-Ubaid I request you to try the rich diff. In all, the indentation related to installation instructions were reduced; they are the same for the installation docs and the README. The section on testing was improved.

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.

2 participants