Skip to content

Commit a7a0ecb

Browse files
Ai-chan-0411claude
andcommitted
feat: add Prettier for code formatting (closes #27)
- Add Prettier (v3) with standard config (.prettierrc.json) - Add .prettierignore for build artifacts and lock files - Integrate eslint-config-prettier to disable conflicting ESLint rules - Add `format` and `format:check` npm scripts - Format all existing source files with Prettier Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent a6b0119 commit a7a0ecb

32 files changed

Lines changed: 359 additions & 254 deletions

.github/ISSUE_TEMPLATE/bug-report.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
---
22
name: Bug Report
33
about: Reporting bugs in existing code
4-
title: ''
4+
title: ""
55
labels: bug, good first issue
6-
assignees: ''
7-
6+
assignees: ""
87
---
98

109
## The Problem

.github/ISSUE_TEMPLATE/documentation.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
---
22
name: Documentation
33
about: Report issues or additions to Documentation
4-
title: ''
4+
title: ""
55
labels: documentation, good first issue
6-
assignees: ''
7-
6+
assignees: ""
87
---
98

109
## Description of what to add

.github/ISSUE_TEMPLATE/feature-change-request.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
---
22
name: Feature-Change Request
33
about: Suggest a change in an existing feature
4-
title: ''
4+
title: ""
55
labels: change, good first issue
6-
assignees: ''
7-
6+
assignees: ""
87
---
98

109
## What needs to change

.github/ISSUE_TEMPLATE/feature-request.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
---
22
name: Feature Request
33
about: Suggest a new feature for this project
4-
title: ''
4+
title: ""
55
labels: feature, good first issue
6-
assignees: ''
7-
6+
assignees: ""
87
---
98

109
## Description of the feature

.github/ISSUE_TEMPLATE/refactoring.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
---
22
name: Refactoring Request
33
about: Suggest refactoring or code quality improvements
4-
title: ''
4+
title: ""
55
labels: refactoring, good first issue
6-
assignees: ''
7-
6+
assignees: ""
87
---
98

109
## Area to Refactor
@@ -20,9 +19,7 @@ assignees: ''
2019

2120
- describe the refactoring approach in bullet points
2221

23-
2422
> [!NOTE]
2523
> **CONTRIBUTIONS ARE WELCOME!**
2624
> If you want to get this issue assigned to you, just comment `assign this issue to me`.
2725
> You will be assigned to the issue instantly via GitHub-actions bot.
28-

.prettierignore

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
.next
2+
node_modules
3+
out
4+
dist
5+
build
6+
pnpm-lock.yaml
7+
package-lock.json

.prettierrc.json

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"semi": true,
3+
"trailingComma": "es5",
4+
"singleQuote": false,
5+
"printWidth": 80,
6+
"tabWidth": 2,
7+
"useTabs": false,
8+
"bracketSpacing": true,
9+
"arrowParens": "always",
10+
"endOfLine": "lf",
11+
"jsxSingleQuote": false
12+
}

CONTRIBUTING.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,16 +37,19 @@ Thank you for your interest in contributing to DevImpact! This guide will help y
3737
### Installation
3838

3939
1. Install dependencies:
40+
4041
```bash
4142
pnpm install
4243
```
4344

4445
2. Create a `.env` file in the project root (see `.env.example`):
46+
4547
```
4648
GITHUB_TOKEN=your_github_token_here
4749
```
4850

4951
3. Start the development server:
52+
5053
```bash
5154
pnpm dev
5255
```
@@ -79,25 +82,29 @@ DevImpact/
7982
## Making Changes
8083

8184
1. **Sync your fork** with the latest upstream changes:
85+
8286
```bash
8387
git fetch upstream
8488
git checkout main
8589
git merge upstream/main
8690
```
8791

8892
2. **Create a feature branch** from `main`:
93+
8994
```bash
9095
git checkout -b feat/your-feature-name
9196
```
9297

9398
3. **Make your changes** and test them locally.
9499

95100
4. **Run the linter** before committing:
101+
96102
```bash
97103
pnpm lint
98104
```
99105

100106
5. **Commit your changes** with a clear message:
107+
101108
```bash
102109
git commit -m "feat: add your feature description"
103110
```

README.md

Lines changed: 47 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# 🚀 DevImpact
2+
23
![License](https://img.shields.io/github/license/o2sa/devimpact)
34
![Stars](https://img.shields.io/github/stars/o2sa/devimpact)
45
![Forks](https://img.shields.io/github/forks/o2sa/devimpact)
@@ -11,14 +12,13 @@
1112
![Node.js](https://img.shields.io/badge/Node.js-green?logo=node.js)
1213
![GraphQL](https://img.shields.io/badge/GraphQL-pink?logo=graphql)
1314

14-
1515
**DevImpact** is an open-source platform that compares software developers based on their real impact in the open-source ecosystem — not just raw numbers.
1616

1717
It evaluates developers using a smart scoring system that considers:
1818

19-
* Repository quality 📦
20-
* Pull request impact 🔀
21-
* Community contributions 💬
19+
- Repository quality 📦
20+
- Pull request impact 🔀
21+
- Community contributions 💬
2222

2323
---
2424

@@ -28,9 +28,9 @@ Traditional metrics (followers, stars, commit counts) are often misleading.
2828

2929
DevImpact focuses on:
3030

31-
* ✅ Quality over quantity
32-
* ✅ Real contributions to valuable projects
33-
* ✅ Fair comparison between developers
31+
- ✅ Quality over quantity
32+
- ✅ Real contributions to valuable projects
33+
- ✅ Fair comparison between developers
3434

3535
---
3636

@@ -44,9 +44,9 @@ Measures the quality and impact of repositories owned by the user.
4444

4545
Factors include:
4646

47-
* Stars ⭐
48-
* Forks 🍴
49-
* Watchers
47+
- Stars ⭐
48+
- Forks 🍴
49+
- Watchers
5050

5151
---
5252

@@ -59,10 +59,10 @@ Measures contributions to **other developers' repositories**.
5959

6060
Factors include:
6161

62-
* Target repository quality
63-
* PR size (additions/deletions)
64-
* Repository popularity
65-
* Contribution diversity
62+
- Target repository quality
63+
- PR size (additions/deletions)
64+
- Repository popularity
65+
- Contribution diversity
6666

6767
---
6868

@@ -72,8 +72,8 @@ Measures community engagement.
7272

7373
Includes:
7474

75-
* Issues opened in external repositories
76-
* Discussions participation
75+
- Issues opened in external repositories
76+
- Discussions participation
7777

7878
⚠️ Does NOT include commits or PRs (to avoid duplication)
7979

@@ -96,44 +96,41 @@ Final Score =
9696

9797
## ⚖️ Key Design Principles
9898

99-
* ❌ No self-inflation (own PRs excluded)
100-
* 📉 Diminishing returns to prevent spam
101-
* 🎯 External impact is prioritized
102-
* ⚖️ Balanced scoring between builders and contributors
99+
- ❌ No self-inflation (own PRs excluded)
100+
- 📉 Diminishing returns to prevent spam
101+
- 🎯 External impact is prioritized
102+
- ⚖️ Balanced scoring between builders and contributors
103103

104104
---
105105

106106
## 🖥️ Features
107107

108-
* 🔍 Compare two GitHub users side-by-side
109-
* 📊 Visual score breakdown (charts & insights)
110-
* 🧠 Smart ranking system
111-
* 🌍 Localization support (EN / AR)
112-
* ⚡ Fast API powered by GitHub GraphQL
113-
* 🧩 Extensible scoring system
108+
- 🔍 Compare two GitHub users side-by-side
109+
- 📊 Visual score breakdown (charts & insights)
110+
- 🧠 Smart ranking system
111+
- 🌍 Localization support (EN / AR)
112+
- ⚡ Fast API powered by GitHub GraphQL
113+
- 🧩 Extensible scoring system
114114

115115
---
116116

117117
## 🛠️ Tech Stack
118118

119119
### Frontend
120120

121-
* Next.js (App Router)
122-
* TypeScript
123-
* Tailwind CSS
124-
* Recharts
121+
- Next.js (App Router)
122+
- TypeScript
123+
- Tailwind CSS
124+
- Recharts
125125

126126
### API
127127

128-
* Node.js + Express
129-
* GitHub GraphQL API
130-
* Octokit
128+
- Node.js + Express
129+
- GitHub GraphQL API
130+
- Octokit
131131

132132
---
133133

134-
135-
136-
137134
## 🚀 Getting Started
138135

139136
### 1. Clone the repo
@@ -173,14 +170,13 @@ pnpm run dev
173170

174171
## 🌍 Localization
175172

176-
* Supported languages: English 🇺🇸, Arabic 🇸🇦
177-
* Automatically detects user language
178-
* Allows manual switching
179-
* Easy to add new languages via `/locales`
173+
- Supported languages: English 🇺🇸, Arabic 🇸🇦
174+
- Automatically detects user language
175+
- Allows manual switching
176+
- Easy to add new languages via `/locales`
180177

181178
---
182179

183-
184180
## 🤝 Contributing
185181

186182
Contributions are welcome!
@@ -196,22 +192,21 @@ Contributions are welcome!
196192

197193
### Contribution ideas:
198194

199-
* Improve scoring algorithm
200-
* Add new metrics
201-
* Enhance UI/UX
202-
* Add new languages 🌍
195+
- Improve scoring algorithm
196+
- Add new metrics
197+
- Enhance UI/UX
198+
- Add new languages 🌍
203199

204200
---
205201

206202
## ⚠️ Limitations
207203

208-
* GitHub API rate limits
209-
* Some private contributions are not accessible
210-
* Scoring system is heuristic (not perfect)
204+
- GitHub API rate limits
205+
- Some private contributions are not accessible
206+
- Scoring system is heuristic (not perfect)
211207

212208
---
213209

214-
215210
## 💡 Inspiration
216211

217212
DevImpact was created to answer a simple question:
@@ -224,7 +219,6 @@ DevImpact was created to answer a simple question:
224219

225220
If you like this project:
226221

227-
* ⭐ Star the repo
228-
* 🐛 Report issues
229-
* 💡 Suggest features
230-
222+
- ⭐ Star the repo
223+
- 🐛 Report issues
224+
- 💡 Suggest features

0 commit comments

Comments
 (0)