Skip to content

Commit 0a6ec04

Browse files
Merge pull request #86 from khushal1512/docs-readme
docs: add standard project README
2 parents c008fc3 + f713f0c commit 0a6ec04

3 files changed

Lines changed: 130 additions & 96 deletions

File tree

Contributing.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ This creates your own copy under your account.
5656

5757
## 💻 Step 4: Clone Your Fork
5858

59-
```
59+
```bash
6060
git clone https://github.com/YOUR-USERNAME/IdentityTokens-EVM-Frontend.git
6161
cd IdentityTokens-EVM-Frontend
6262
```
@@ -65,7 +65,7 @@ cd IdentityTokens-EVM-Frontend
6565

6666
## 🔗 Step 5: Add Upstream Remote
6767

68-
```
68+
```bash
6969
git remote add upstream https://github.com/StabilityNexus/IdentityTokens-EVM-Frontend.git
7070
git remote -v
7171
```
@@ -76,7 +76,7 @@ git remote -v
7676

7777
Never work on main.
7878

79-
```
79+
```bash
8080
git checkout -b feature/short-description
8181
```
8282

@@ -93,7 +93,7 @@ Examples:
9393

9494
## 📦 Install Dependencies
9595

96-
```
96+
```bash
9797
npm install
9898
```
9999

@@ -117,7 +117,7 @@ Husky is used for pre-commit hooks.
117117

118118
If needed:
119119

120-
```
120+
```bash
121121
npm run prepare
122122
```
123123

@@ -134,7 +134,7 @@ If commit fails, fix errors before retrying.
134134

135135
## ▶️ Start Development Server
136136

137-
```
137+
```bash
138138
npm run dev
139139
```
140140

@@ -144,15 +144,15 @@ App runs locally (usually [http://localhost:3000](http://localhost:3000)).
144144

145145
## 🏗 Build Project
146146

147-
```
147+
```bash
148148
npm run build
149149
```
150150

151151
---
152152

153153
## 🚀 Start Production Server
154154

155-
```
155+
```bash
156156
npm run start
157157
```
158158

@@ -166,19 +166,19 @@ Before committing:
166166

167167
## 🔍 Run ESLint
168168

169-
```
169+
```bash
170170
npm run lint
171171
```
172172

173173
## ✨ Format Code
174174

175-
```
175+
```bash
176176
npm run format
177177
```
178178

179179
## ✅ Check Formatting
180180

181-
```
181+
```bash
182182
npm run check-format
183183
```
184184

@@ -232,7 +232,7 @@ Test wallet connection manually before PR.
232232

233233
# 7️⃣ Commit Properly
234234

235-
```
235+
```bash
236236
git add .
237237
git commit -m "feat: short clear description"
238238
```
@@ -252,7 +252,7 @@ Avoid vague messages like "update".
252252

253253
Before pushing:
254254

255-
```
255+
```bash
256256
git fetch upstream
257257
git merge upstream/main
258258
```
@@ -263,7 +263,7 @@ Resolve conflicts locally.
263263

264264
# 9️⃣ Push Your Branch
265265

266-
```
266+
```bash
267267
git push origin feature/short-description
268268
```
269269

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 The Stable Order
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

0 commit comments

Comments
 (0)