Skip to content

Commit 5ab1116

Browse files
committed
chore: implement commitlint with conventional commits standard
1 parent b4e2fd1 commit 5ab1116

3 files changed

Lines changed: 71 additions & 0 deletions

File tree

.husky/commit-msg

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
npx --no -- commitlint --edit "$1"

CONTRIBUTING.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Contributing to TradeFlow-Web
2+
3+
Thank you for your interest in contributing! Please follow the guidelines below to keep our codebase clean and consistent.
4+
5+
---
6+
7+
## Commit Message Convention
8+
9+
This project enforces [Conventional Commits](https://www.conventionalcommits.org/) using **Commitlint** and **Husky**.
10+
11+
Every commit message must follow this format:
12+
13+
\`\`\`
14+
type(scope): subject
15+
\`\`\`
16+
17+
### Examples
18+
19+
\`\`\`
20+
feat: add wallet modal
21+
fix(api): resolve CORS issue
22+
chore: update dependencies
23+
docs: update README setup steps
24+
refactor(auth): simplify token validation logic
25+
test(dashboard): add unit tests for chart component
26+
\`\`\`
27+
28+
### Allowed Types
29+
30+
| Type | Description |
31+
| -------- | ----------------------------------------- |
32+
| feat | A new feature |
33+
| fix | A bug fix |
34+
| chore | Maintenance tasks (deps, config, tooling) |
35+
| docs | Documentation changes only |
36+
| refactor | Code change that is not a fix or feature |
37+
| test | Adding or updating tests |
38+
| style | Formatting, missing semicolons, etc. |
39+
| perf | Performance improvements |
40+
| ci | CI/CD configuration changes |
41+
| build | Changes affecting the build system |
42+
43+
### Rules
44+
45+
- The type is **required**
46+
- The subject is **required** and must not be empty
47+
- Use **lowercase** for type and subject
48+
- No period at the end of the subject line
49+
50+
Commits that do not follow this format will be **rejected** by the commit hook.
51+
52+
---
53+
54+
## Running Locally
55+
56+
\`\`\`bash
57+
npm install
58+
npm run dev
59+
\`\`\`
60+
61+
---
62+
63+
## Pull Request Guidelines
64+
65+
- Branch off from main
66+
- Keep PRs focused and small
67+
- Reference the related issue in your PR description (e.g., Closes #259)

commitlint.config.cjs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module.exports = {
2+
extends: ['@commitlint/config-conventional'],
3+
};

0 commit comments

Comments
 (0)