Skip to content

Commit b9626b3

Browse files
authored
Merge pull request #804 from Chisom92/feat/723-pr-template-test-plan
PR template with test plan
2 parents 0860910 + 6ccf622 commit b9626b3

10 files changed

Lines changed: 253 additions & 1121 deletions

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
## Summary
2+
3+
<!-- One or two sentences describing what this PR does and why. -->
4+
5+
## Changes
6+
7+
<!-- Bullet list of the key changes made. -->
8+
9+
-
10+
11+
## Test Plan
12+
13+
### Automated tests added or updated
14+
15+
<!-- Check all that apply and briefly describe what each covers. -->
16+
17+
- [ ] **Unit tests** (`backend/src/**/*.spec.ts`) — service/guard/decorator logic in isolation
18+
- [ ] **Integration / e2e tests** (`backend/test/**/*.e2e-spec.ts`) — HTTP round-trips with mocked infrastructure
19+
- [ ] **Frontend component tests** (`frontend/src/**/*.test.{ts,tsx}`) — React component behaviour
20+
- [ ] **Frontend e2e tests** (`frontend/e2e/**/*.spec.ts`) — Playwright browser flows
21+
- [ ] **Contract tests** (`contract/`) — Soroban/Rust unit tests via `cargo test`
22+
- [ ] No new tests required — explain why: ___
23+
24+
### How to run the tests locally
25+
26+
```bash
27+
# Backend unit tests
28+
cd backend && npm test
29+
30+
# Backend e2e tests (requires no live DB — uses in-memory mocks)
31+
cd backend && npm run test:e2e
32+
33+
# Frontend component tests
34+
cd frontend && npx vitest run
35+
36+
# Frontend e2e tests (requires dev server on :3000 and API on :3001)
37+
cd frontend && npx playwright test
38+
39+
# Contract tests
40+
cd contract && cargo test
41+
```
42+
43+
### Manual verification checklist
44+
45+
<!-- Tick each item you verified by hand before requesting review. -->
46+
47+
- [ ] Happy path works end-to-end in a local environment
48+
- [ ] Error / edge cases handled gracefully (stale state, invalid input, disconnected wallet)
49+
- [ ] No regressions in closely related API or UI flows
50+
- [ ] Rate-limiting, auth guards, and feature flags behave as expected where touched
51+
- [ ] Linting passes: `cd backend && npm run lint` / `cd frontend && npm run lint`
52+
53+
## Related issues
54+
55+
<!-- Closes #NNN -->
56+
57+
## Notes for reviewers
58+
59+
<!-- Anything that needs extra attention, known limitations, or follow-up work. -->

.github/workflows/ci.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ jobs:
4343
DB_PASSWORD: myfans_ci
4444
DB_NAME: myfans_test
4545
JWT_SECRET: ci-test-secret-not-for-production
46+
WEBHOOK_SECRET: ci-webhook-secret-not-for-production
4647
NODE_ENV: test
4748
STELLAR_NETWORK: testnet
4849
SOROBAN_RPC_URL: https://soroban-testnet.stellar.org
@@ -266,4 +267,4 @@ jobs:
266267

267268
- name: Build
268269
run: cargo build --release
269-
working-directory: contract
270+
working-directory: contract

CI_CHECKS_STATUS.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

FEATURE_FLAGS.md

Lines changed: 0 additions & 41 deletions
This file was deleted.

INTEGRATION.md

Lines changed: 0 additions & 165 deletions
This file was deleted.

0 commit comments

Comments
 (0)