Skip to content

Commit 0b5e79e

Browse files
authored
Merge pull request #10 from niziiromao/docs/fix-contributing-md
docs: fixing typo in CONTRIBUTING.md
2 parents aedecc7 + 4bf9d09 commit 0b5e79e

File tree

1 file changed

+37
-34
lines changed

1 file changed

+37
-34
lines changed

CONTRIBUTING.md

Lines changed: 37 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -8,33 +8,37 @@ We welcome all contributions, from small documentation fixes to major feature im
88
## 🧭 Getting Started
99

1010
1. **Fork** this repository and clone it locally:
11-
```bash
12-
git clone https://github.com/asepindrak>/commitflow.git
13-
cd commitflow
14-
```
11+
12+
```bash
13+
git clone https://github.com/asepindrak/commitflow.git
14+
cd commitflow
15+
```
1516

1617
2. Create a new branch for your changes:
17-
```bash
18-
git checkout -b feat/your-feature-name
19-
```
18+
19+
```bash
20+
git checkout -b feat/your-feature-name
21+
```
2022

2123
3. Make your changes and ensure everything works:
22-
```bash
23-
npm run lint
24-
npm run test
25-
```
24+
25+
```bash
26+
npm run lint
27+
npm run test
28+
```
2629

2730
4. Commit your changes using Conventional Commits:
28-
```bash
29-
feat: add new AI insight generator
30-
fix: resolve API token validation issue
31-
chore: update Docker build script
32-
```
31+
32+
```bash
33+
feat: add new AI insight generator
34+
fix: resolve API token validation issue
35+
chore: update Docker build script
36+
```
3337

3438
5. Push your branch and open a Pull Request (PR):
35-
```bash
36-
git push origin feat/your-feature-name
37-
```
39+
```bash
40+
git push origin feat/your-feature-name
41+
```
3842

3943
---
4044

@@ -55,30 +59,30 @@ Access the services:
5559
- pgAdmin: http://localhost:8080
5660

5761
If you’re running it for the first time, migrate the database:
58-
```bash
62+
`bash
5963
docker exec -it commitflow-api npx prisma db push
60-
```
64+
`
6165

6266
---
6367

6468
## 🧠 Commit Message Convention ✨
69+
6570
We follow Conventional Commits:
66-
| Type | Description |
71+
| Type | Description |
6772
| ----------- | ----------------------------------------------------- |
68-
| `feat:` | A new feature |
69-
| `fix:` | A bug fix |
70-
| `docs:` | Documentation only changes |
71-
| `style:` | Code style (formatting, etc.) |
73+
| `feat:` | A new feature |
74+
| `fix:` | A bug fix |
75+
| `docs:` | Documentation only changes |
76+
| `style:` | Code style (formatting, etc.) |
7277
| `refactor:` | Code changes that neither fix a bug nor add a feature |
73-
| `perf:` | Performance improvements |
74-
| `test:` | Adding or fixing tests |
75-
| `chore:` | Maintenance or build tasks |
78+
| `perf:` | Performance improvements |
79+
| `test:` | Adding or fixing tests |
80+
| `chore:` | Maintenance or build tasks |
7681

7782
Example:
78-
```bash
83+
`bash
7984
feat: integrate GitHub API for contribution tracking
80-
```
81-
85+
`
8286

8387
## 🧪 Running Tests ✨
8488

@@ -87,6 +91,7 @@ If tests are available, you can run them with:
8791
```bash
8892
npm test
8993
```
94+
9095
---
9196

9297
## 🧾 Submitting Issues ✨
@@ -97,12 +102,10 @@ When reporting a bug or suggesting a feature:
97102
- Include steps to reproduce, expected behavior, and screenshots (if applicable).
98103
- Use a clear and descriptive title.
99104

100-
101105
## ❤️ Code of Conduct ✨
102106

103107
By contributing, you agree to follow our Code of Conduct
104108

105-
106109
## 🌟 Thank You!
107110

108111
Your contributions make CommitFlow better for everyone.

0 commit comments

Comments
 (0)