Skip to content

Commit c92a544

Browse files
Addressing PR review comments
1 parent b28def6 commit c92a544

File tree

1 file changed

+33
-30
lines changed

1 file changed

+33
-30
lines changed

docs/RepositoryGuide.md

Lines changed: 33 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,9 @@ All POMs are located in the `pages/` directory.<br>
5252
Each POM encapsulates locators and methods for interacting with a specific page or feature in the UI.<br>
5353
The purpose of POMs is to promote reusability and maintainability of the automation code by providing a clear structure for page interactions.<br>
5454

55-
The POMs have been organised into folders based on the base/main page to allow for easier navigation.<br>
55+
The POMs have been organised into folders based on the main menu within the UI to allow for easier navigation.<br>
5656
POMs follow the naming convention of `<page_name>_page.py` to clearly indicate their purpose.<br>
57+
All of the POMs inherit the `BasePage` POM. This is so that they can leverage common functionality such as the common click method.<br>
5758

5859
Please refer to the list below for all available POMs in this repository.
5960

@@ -445,35 +446,37 @@ You can also use repositories to fetch or update domain objects, set up test dat
445446

446447
### Class Descriptions
447448

448-
- **address/**: Models address data and types.
449-
- **appointment/**: Models appointment slots and statuses.
450-
- **bowel_scope/**: Models bowel scope change reasons.
451-
- **ceased/**: Models cease confirmation details and reasons.
452-
- **data/**: Data creation helpers for test setup.
453-
- **database/**: Database error handling and transition parameter classes.
454-
- **datasets/**: Models for dataset fields, cancer treatment, and related enums.
455-
- **date/**: Date description and utility classes for parsing and formatting dates.
456-
- **deduction/**: Deduction reason types.
457-
- **diagnostic/**: Diagnostic test types, outcomes, and related logic.
458-
- **entities/**: Entity classes for kit management.
459-
- **episode/**: Models episode status, type, and related logic.
460-
- **event/**: Event code and status types.
461-
- **invitation/**: Invitation plan and status models.
462-
- **kits/**: Kit management, types, and status classes.
463-
- **lynch/**: Lynch syndrome incident and change reason types.
464-
- **notify/**: Notification event and message status/types.
465-
- **organisation/**: Organisation and complex organisation models.
466-
- **person/**: Person models, accreditation, roles, and selection criteria.
467-
- **recall/**: Recall calculation and episode types.
468-
- **referral/**: Referral date and reason types.
469-
- **repositories/**: Repository classes for DB access (depend on entity/data classes).
470-
- **role/**: Role type enums.
471-
- **screening/**: Screening centre, status, and region models.
472-
- **subject/**: Subject models, gender, and PI subject.
473-
- **subject_selection_query_builder/**: Selection builder and criteria key classes.
474-
- **surveillance/**: Surveillance review and change reason types.
475-
- **user/**: User models and role types.
476-
- **yes_no/**: Yes/No type enums.
449+
| Folder | Description |
450+
|--------------------------------------|--------------------------------------------------------------------|
451+
| address | Models address data and types. |
452+
| appointment | Models appointment slots and statuses. |
453+
| bowel_scope | Models bowel scope change reasons. |
454+
| ceased | Models cease confirmation details and reasons. |
455+
| data | Data creation helpers for test setup. |
456+
| database | Database error handling and transition parameter classes. |
457+
| datasets | Models for dataset fields, cancer treatment, and related enums. |
458+
| date | Date description and utility classes for parsing and formatting. |
459+
| deduction | Deduction reason types. |
460+
| diagnostic | Diagnostic test types, outcomes, and related logic. |
461+
| entities | Entity classes for kit management. |
462+
| episode | Models episode status, type, and related logic. |
463+
| event | Event code and status types. |
464+
| invitation | Invitation plan and status models. |
465+
| kits | Kit management, types, and status classes. |
466+
| lynch | Lynch syndrome incident and change reason types. |
467+
| notify | Notification event and message status/types. |
468+
| organisation | Organisation and complex organisation models. |
469+
| person | Person models, accreditation, roles, and selection criteria. |
470+
| recall | Recall calculation and episode types. |
471+
| referral | Referral date and reason types. |
472+
| repositories | Repository classes for DB access (depend on entity/data classes). |
473+
| role | Role type enums. |
474+
| screening | Screening centre, status, and region models. |
475+
| subject | Subject models, gender, and PI subject. |
476+
| subject_selection_query_builder | Selection builder and criteria key classes. |
477+
| surveillance | Surveillance review and change reason types. |
478+
| user | User models and role types. |
479+
| yes_no | Yes/No type enums. |
477480

478481
---
479482

0 commit comments

Comments
 (0)