You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+21-11Lines changed: 21 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,12 @@
1
-
```markdown
1
+
````markdown
2
2
# Contributing to SwiftChain Frontend
3
3
4
-
Thank you for your interest in contributing to the **SwiftChain Frontend**! We welcome contributions from the community to help build the user interface for our Blockchain-Powered Logistics & Escrow Delivery Platform.
4
+
Thank you for your interest in contributing to the **SwiftChain Frontend**! We welcome contributions from the community to help build the user interface for our Blockchain-Powered Logistics & Escrow Delivery Platform.
5
5
6
6
Whether you are building out new Next.js UI components, fixing bugs, or proposing new user features, your help is incredibly valuable.
7
7
8
8
## Product Reference
9
+
9
10
Before contributing, please review our comprehensive Product Requirements Document to understand our users, features, and rollout phases:
-**Roles Supported**: Customer, Driver, and Admin.
32
+
-**Prerequisites**: Node.js (v18 or higher) and your preferred package manager (npm, yarn, or pnpm).
32
33
33
34
### Installation & Setup
34
35
35
36
1. **Install dependencies:**
36
37
```bash
37
38
pnpm install
38
39
```
40
+
````
41
+
39
42
2. **Setup environment variables:**
43
+
40
44
```bash
41
45
cp .env.example .env.local
42
46
```
43
-
*(Fill in the required local variables inside `.env.local`)*
47
+
48
+
_(Fill in the required local variables inside `.env.local`)_
44
49
45
50
3. **Start the development server:**
46
51
```bash
@@ -59,9 +64,11 @@ The frontend application is the customer and administrator-facing interface allo
59
64
We believe the community should drive the project's priorities based on the phased rollout outlined in our PRD (Phase 1 MVP ➔ Escrow ➔ Scaling).
60
65
61
66
### Tackling Existing Issues
67
+
62
68
When looking for something to work on, please check the GitHub Issues tab. We recommend filtering by our standard priority tags (`high`, `medium`, `low`) or type tags (`frontend`, `ui`).
63
69
64
70
### Requesting a New Feature
71
+
65
72
1. **Check existing requests**: Browse existing Issues to avoid duplicates.
66
73
2. **Open an Issue**: Include a descriptive title, the problem/use case in the logistics flow, your proposed solution, and link back to the PRD document if applicable.
67
74
@@ -70,10 +77,10 @@ When looking for something to work on, please check the GitHub Issues tab. We re
70
77
1. **Ensure all checks pass**: Run frontend linters and ensure there are zero strict TypeScript errors before submitting.
71
78
2. **Update documentation**: If you change the routing architecture or core component structure, update the relevant markdown files.
72
79
3. **Format your code**: Run your Prettier/ESLint formatting scripts.
73
-
4. **Submit your PR** to the `main` branch.
74
-
* Provide a clear description of the visual and functional changes.
75
-
* Upload a **screenshot** or video recording of the working UI.
76
-
* Include `Closes #[issue_id]` in the description to automatically link the PR to the issue.
80
+
4. **Submit your PR** to the `main` branch.
81
+
- Provide a clear description of the visual and functional changes.
82
+
- Upload a **screenshot** or video recording of the working UI.
83
+
- Include `Closes #[issue_id]` in the description to automatically link the PR to the issue.
77
84
78
85
---
79
86
@@ -85,4 +92,7 @@ By contributing, you agree that your contributions will be licensed under the **
0 commit comments