Skip to content

Fix developer guide image path issue and update readme #3573

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.

Sign up for GitHub

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

Merged
kneerose merged 2 commits into from
May 6, 2025
Merged

Fix developer guide image path issue and update readme #3573

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8c3f1a6
fix: update image paths in Developer's Guide for correct relative ref…
kneerose May 6, 2025
fe2d111
chore: make pillar singular on readme
kneerose May 6, 2025
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
20 changes: 10 additions & 10 deletions tests/govtool-frontend/playwright/DEVELOPERS_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ This directory contains all automated test cases, organized by feature area:
- Use the terminal to run specific test suites using the commands provided in the **README.md**.
- Ensure all test files are recognized in the **Test Explorer**.

![Test Runner Screenshot](/docs/image.png)
![Test Runner Screenshot](./docs/image.png)

- Use the **Play** ▶️ icon to run individual tests directly from the UI.

Expand All @@ -127,12 +127,12 @@ This directory contains all automated test cases, organized by feature area:

- Add **Playwright Test for VSCode** extension

![Playwright Test Screenshot](/docs/image-1.png)
![Playwright Test Screenshot](./docs/image-1.png)

1. **Remove** the `CI` environment variable.
2. **Navigate** to the specific directory where your test is located to run it directly.

![Directory Navigation Screenshot](/docs/image-2.png)
![Directory Navigation Screenshot](./docs/image-2.png)

> **Note:**
>
Expand All @@ -149,15 +149,15 @@ This section outlines the core behavioral areas of the Govtool application as ca

This set of tests covers all key UI and interaction flows related to delegation functionality.

![Delegation Pillars](/docs/delegation-pillars.png)
![Delegation Pillars](./docs/delegation-pillars.png)

---

### 2. Voting Pillars

Covers user voting mechanisms, including interface states and validation of voting logic.

![Voting Pillars](/docs/voting-pillars.png)
![Voting Pillars](./docs/voting-pillars.png)

---

Expand All @@ -169,34 +169,34 @@ Proposal functionality is split into two sub-categories, each with distinct test

Tracks creation, display, and participation in proposal discussions.

![Proposal Discussion](/docs/proposal-discussion.png)
![Proposal Discussion](./docs/proposal-discussion.png)

#### ii. Budget Proposal

Tracks creation, display, and participation in budget-related proposals.

![Budget Proposal](/docs/budget-proposal.png)
![Budget Proposal](./docs/budget-proposal.png)

---

### 4. Outcomes Pillars

Tests centered around outcomes from various actions.

![Outcomes Pillars](/docs/outcomes-pillars.png)
![Outcomes Pillars](./docs/outcomes-pillars.png)

---

### 5. Logged-In State

Covers all test cases that require the user to be authenticated, and are not included in the delegation, voting, proposal, or outcomes pillars

![Logged-In State](/docs/loggedin.png)
![Logged-In State](./docs/loggedin.png)

---

### Overall Architecture

For a comprehensive view of the project's Playwright architecture, refer to the Excalidraw diagram:

[Govtool Project Architecture](/docs/govtool-playwright-project.excalidraw)
[Govtool Project Architecture](./docs/govtool-playwright-project.excalidraw)
14 changes: 7 additions & 7 deletions tests/govtool-frontend/playwright/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,13 +122,13 @@ Each test suite can be run in **UI** or **Headless** mode.
#### 🖥️ UI Mode

```bash
npm run test:delegation-pillars
npm run test:delegation-pillar
```

#### 🧪 Headless Mode (No UI)

```bash
npm run test:headless:delegation-pillars
npm run test:headless:delegation-pillar
```

---
Expand All @@ -140,13 +140,13 @@ npm run test:headless:delegation-pillars
#### 🖥️ UI Mode

```bash
npm run test:voting-pillars
npm run test:voting-pillar
```

#### 🧪 Headless Mode (No UI)

```bash
npm run test:headless:voting-pillars
npm run test:headless:voting-pillar
```

---
Expand Down Expand Up @@ -176,13 +176,13 @@ _Includes both Proposal Discussion and Budget Discussion_
#### 🖥️ UI Mode

```bash
npm run test:proposal-pillars
npm run test:proposal-pillar
```

#### 🧪 Headless Mode (No UI)

```bash
npm run test:headless:proposal-pillars
npm run test:headless:proposal-pillar
```

---
Expand Down Expand Up @@ -285,4 +285,4 @@ npm run allure:serve

For contribution guidelines and development tips, refer to:

📄 **[DEVELOPERS_GUIDE.md](/DEVELOPERS_GUIDE.md)**
📄 **[DEVELOPERS_GUIDE.md](./DEVELOPERS_GUIDE.md)**
12 changes: 6 additions & 6 deletions tests/govtool-frontend/playwright/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,20 +24,20 @@
"allure:open": "npx allure open ./allure-report",
"allure:serve": "npx allure serve",
"test": "npx playwright test --ui",
"test:delegation-pillars": "npx playwright test delegation dRepRegistration editDRep --ui",
"test:voting-pillars": "npx playwright test proposalVisibility proposalFunctionality --ui",
"test:delegation-pillar": "npx playwright test delegation dRepRegistration editDRep --ui",
"test:voting-pillar": "npx playwright test proposalVisibility proposalFunctionality --ui",
"test:outcomes": "npx playwright test outcomes --ui",
"test:proposal-pillars": "npx playwright test proposalDiscussion proposalSubmission proposalBudget --ui",
"test:proposal-pillar": "npx playwright test proposalDiscussion proposalSubmission proposalBudget --ui",
"test:proposal-discussion": "npx playwright test proposalDiscussion proposalSubmission --ui",
"test:proposal-budget": "npx playwright test proposalBudget --ui",
"test:wallet-connect": "npx playwright test walletConnect --ui",
"test:usersnap": "npx playwright test userSnap.spec.ts --ui",
"test:misc": "npx playwright test miscellaneous --ui",
"test:headless": "npx playwright test",
"test:headless:delegation-pillars": "npx playwright test delegation dRepRegistration editDRep",
"test:headless:voting-pillars": "npx playwright test proposalVisibility proposalFunctionality",
"test:headless:delegation-pillar": "npx playwright test delegation dRepRegistration editDRep",
"test:headless:voting-pillar": "npx playwright test proposalVisibility proposalFunctionality",
"test:headless:outcomes": "npx playwright test outcomes",
"test:headless:proposal-pillars": "npx playwright test proposalDiscussion proposalSubmission proposalBudget",
"test:headless:proposal-pillar": "npx playwright test proposalDiscussion proposalSubmission proposalBudget",
"test:headless:proposal-discussion": "npx playwright test proposalDiscussion proposalSubmission",
"test:headless:proposal-budget": "npx playwright test proposalBudget",
"test:headless:wallet-connect": "npx playwright test walletConnect",
Expand Down