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

Updated Documents as per React UI - Set 3 #291

Merged
merged 4 commits into from
Sep 29, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
101 changes: 37 additions & 64 deletions src/pages/docs/collaboration/test-cases-review-management.md
Original file line number Diff line number Diff line change
@@ -1,106 +1,79 @@
---
title: "Review Management for Test Cases"
metadesc: "How to review test cases created in Testsigma."
page_title: "Test Case Review Management | Testsigma Documentaion"
metadesc: "Learn how Testsigma's Test Case Review Management enhances collaboration, improves accuracy, and streamlines testing processes to boost testing efficiency."
noindex: false
order: 3.3
page_id: "Review Management for Test Cases"
page_id: "test-case-review-management-testsigma"
warning: false
contextual_links:
- type: section
name: "Contents"
- type: link
name: "Pre-requisites"
url: "#pre-requisites"
name: "Enable Test Case Review Management and Self Review"
url: "#enable-test-case-review-management-and-self-review"
- type: link
name: "How to send a test case for review"
url: "#how-to-send-a-test-case-for-review"
name: "Submit Test Case for Review"
url: "#submit-test-case-for-review"
- type: link
name: "Steps to follow when you want a team member to review your test case"
url: "#steps-to-follow-when-you-want-a-team-member-to-review-your-test-case"
name: "Reviewing a Test Case"
url: "#reviewing-a-test-case"
- type: link
name: "How to self-review a test case"
url: "#how-to-self-review-a-test-case"
name: "Self Review a Test Case"
url: "#self-review-a-test-case"
---

---

You can work together with your team to create and maintain test cases in Testsigma using the Review Management feature. This feature enables you to send your test cases for review easily, review the test cases created by your team, and even check your own work for accuracy and quality. Testsigma provides two ways to assist with test case reviews.

Once a test case is created in Testsigma, it can be submitted for review. Testsigma provides two different ways of managing test case reviews.
1. **Self-review**: The person who created the test can review their work.
2. **Review involving other team members**: The person who created the test can ask other team members to review their test cases.

1. **Self-review:** Here the test creator is able to review their own test cases.

2. **Review management involving other team members:** Here, the test creator can submit the test cases for review to other team members.

In this document, we will cover both ways of reviewing and subsequently managing test case reviews.

 
This documentation will guide you through enabling and using Test Case Review Management in Testsigma.

---
##**Pre-requisites:**
1. You should know how to create a test case in Testsigma. If not, refer to [creating a test case](https://testsigma.com/docs/test-cases/manage/add-edit-delete/).

2. To enable review management in Testsigma, make sure the option ‘Test Case Review Management’ is enabled under ‘Settings > Preferences’

![ test case review management and self review management options in Testsigma](https://docs.testsigma.com/images/test-cases-review-management/test-case-review-management-self-review-management-options-testsigma.png)

3. To enable self-review, hit the toggle in ‘Self-review management’.
### **Prerequisites**

 
Before using Test Case Review Management, you must understand specific concepts such as creating [Projects](https://testsigma.com/docs/projects/overview/), [Test Cases](https://testsigma.com/docs/test-cases/manage/add-edit-delete/), and managing [Users and Roles](https://testsigma.com/docs/collaboration/users-roles/).

---
##**How to send a test case for review:**
1. Go to the Project

2. Go to Test Development > Test Cases

3. Create a new test case

4. Once you have created the test case, click on the ‘Submit for Review’ button that appears in the top right corner.

![submit for review button on a test case page in Testsigma](https://docs.testsigma.com/images/test-cases-review-management/submit-for-review-button-test-case-page-testsigma.png)

5. The ‘Submit for Review’ form will show up. By default the test creator is selected as the reviewer here:

![Submit for Review form for a test case in Testsigma](https://docs.testsigma.com/images/test-cases-review-management/submit-for-review-form-test-case-Testsigma.png)

6. From the reviewer drop-down, select the user that should review your test case, add any comments you have in the comments section, and click on the ‘Submit’ button.
## **Enable Test Case Review Management and Self Review**

7. Once submitted, the reviewer will receive an email notifying them that they have been assigned a test case to review. You can also track the status of the review from the ‘SUBMITTED FOR REVIEW’ section displayed on the dashboard.
Follow these steps to enable Test Case Review Management and Self Review in your Testsigma account:

 
1. Click on the **Settings** tab in the left-side navbar of the Dashboard. Then, select Preferences and turn on the **Test Case Review Management** toggle. This will enable you to submit test cases for review and review test cases created by your team members.
2. After you enable **Test Case Review Management**, you can also enable **Self-Review Management**. This feature helps you to perform self-reviews as part of the software testing and quality assurance process. ![Enable Test Case Review Management](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/enable_testcasereviewmanagement.gif)

---
##**Steps to follow when you want a team member to review your test case:**
1. When you receive a test case to review, you will be notified of the same in an email. In addition, you can also track the status of the received review requests under the section: ‘Waiting for your review’ on the dashboard:

![Submitted for Review and Waiting for Review test cases on dashboard in Testsigma](https://docs.testsigma.com/images/test-cases-review-management/submitted-for-review-waiting-for-review-test-cases-dashboard-testsigma.png)
## **Submit Test Case for Review**

2. To proceed you can click on the test case link received in the email or click on the test case shown under the ‘WAITING FOR YOUR REVIEW’ section:
Here's how to submit test cases for review and get feedback from your team members after enabling Test Case Review Management:

3. You will be taken to the test case to review.

4. After you have reviewed the test case, to give your review input, click on the ‘Review Test Case’ button on the top right:

![Review Test Case Button on Test Case Page in Testsigma](https://docs.testsigma.com/images/test-cases-review-management/review-test-case-button-test-case-page-testsigma.png)

5. This will bring up the ‘Review test case’ form:

![review test case form in Testsigma](https://docs.testsigma.com/images/test-cases-review-management/review-test-case-form-Testsigma.png)
1. Create a **Test Case** with a list of **test steps**. Then, click **Submit for Review** at the top right of the screen to bring up an overlay.
2. Select a **Reviewer** from the dropdown list, check the box next to **Notify Assignee and Reviewer**, you can add comments in the box, and then click **Submit**. ![Submit Test case for review](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/submitreview_testcase.gif)

[[info | NOTE:]]
| Check the **Submitted for Review** section on the Dashboard to view the **Test Cases** that you have submitted for review.
---

**Here you can:**
## **Reviewing a Test Case**

a. Add in your comments
Follow these steps to review a test case if you have been assigned as a reviewer:

b. Check the box ‘Send comment notification to assignee and reviewer’ if you want to send out notification for your comments.
1. An email notification will inform you when you receive a test case to review. You can also check the **Assigned for your Review** section on the dashboard to keep track of review requests you have received.
2. To start, click either the test case link in the email or select the test case from the **Assigned for your Review** section. It will take you to the test case for review.
3. Click the **Review Testcase** button in the top right corner to provide feedback once you've finished reviewing the test case.
4. After you click the **Review Testcase** button, the **Update Review Status** overlay will appear. You can check the **Notify Assignee and Reviewer** box, add comments, and click **Approve** or **Rework** based on your review assessment. You can repeat these steps as needed until the test case is approved. ![Review Test Case](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/review_testcase.gif)

c. Click on ‘Rework’ or ‘Approve’ according to the status of your review
---

These steps can be repeated until the test case is approved.
## **Self Review a Test Case**

 
You can check your test cases by enabling the **Self Review** feature. You assign the test case for review to yourself and handle all stages of the review, which is identical to when you assign a test case to another team member for review.

---
##**How to self-review a test case:**
The steps to self-review a test case are the same as when you assign another team-member a test case for review. The only difference is that the creator assigns the test case for review to themselves and all stages of reviews are completed by the creator.

9 changes: 4 additions & 5 deletions src/pages/docs/elements/overview.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Element List Actions"
pagetitle: "Element List Actions: Enhancing Element Management in Testsigma"
metadesc: "Explore how Testsigma's Element List Actions streamline element handling, from sorting and filtering to saving filters. Effortlessly optimise your test automation workflow."
pagetitle: "Element List Actions | Testsigma Documentaion"
metadesc: "Learn how Element List Actions in Testsigma empower your test automation. Sort, filter, search, save, and manage elements efficiently for improved testing."
noindex: false
order: 6.11
page_id: "element-list-actions-testsigma"
Expand Down Expand Up @@ -81,7 +81,7 @@ You can use user-defined custom fields and the default fields to filter elements
2. Click **Add Filter** to open the drop-down list and select the desired filters.
3. Click **Save Filter** will make the drop-down list appear for saving the current filter, and select **As New** will open a pop-up window named **Save filter config as**. Click **Reset** to discard the current filter.
4. Enter a name for the configuration in the **Config Name** field and mark the checkbox to make it **Public** (Visible for all users with access to the project). Then, click **Save** to save the filter.
5. Click **Saved Filters** in the menu bar on the **Elements List** page to open the drop-down list. In **Custom Filters**, locate the saved filter, mouse over to the filter, and click the **Edit** button next to the filter name to edit it. To delete the saved filter, click the **Delete** button. ![Save Elememts Filter](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/save_elementslist.gif)
5. Click **Saved Filters** in the menu bar on the **Elements List** page to open the drop-down list. In **Custom Filters**, locate the saved filter, select the filter and mouse over to the filter, and click the **Edit** button next to the filter name to edit it. To delete the saved filter, click the **Delete** button. ![Save Elememts Filter](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/save_elementslist.gif)

---

Expand All @@ -97,8 +97,7 @@ You can use user-defined custom fields and the default fields to filter elements
1. In the **Elements List** Page, click **Saved Filters** from the menu bar.
2. Open the drop-down list by clicking **Add Filter** and choose the additional filtering options you want to apply to the existing ones.
3. Once you have made your desired changes, click on **Save Filter**. This will display a drop-down list, allowing you to save the updated filter. If you want to replace the existing filter, click **Replace Existing**, which will prompt a pop-up window named **Update filter config**.
4. In the **Update filter config** pop-up window, you can enter a new name for the updated filter if necessary. Additionally, you can continue configuring by marking the checkbox to make it **Public** (visible for all users with access to the project). Finally, click **Update** to save the changes to the filter.
5. Enter an updated name if needed or can continue for the configuration in the **Config Name** field and mark the checkbox to make it **Public** (Visible for all users with access to the project). Then, click **Update** to save the filter. ![Update Saved Filters](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/updatesavedfilter_elementslist.gif)
4. In the **Update filter config** pop-up window, you can enter a new name for the updated filter if necessary. Additionally, you can continue configuring by marking the checkbox to make it **Public** (visible for all users with access to the project). Finally, click **Update** to save the changes to the filter. ![Update Saved Filters](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/updatesavedfilter_elementslist.gif)

[[info | NOTE:]]
| If you wish to discard the current filter, click All in the menu bar on the Elements List page.
Expand Down
Loading
Loading