Skip to content

Commit 424a6dc

Browse files
authored
Merge pull request #27 from OPCODE-Open-Spring-Fest/copilot/update-commit-title-format
docs: add conventional commit guidelines and fix CI workflows
2 parents 8fe2e8e + 1428f7a commit 424a6dc

4 files changed

Lines changed: 77 additions & 2 deletions

File tree

.github/COMMIT_CONVENTION.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Commit Message Convention
2+
3+
This project follows the [Conventional Commits](https://www.conventionalcommits.org/) specification.
4+
5+
## Format
6+
7+
```
8+
type(scope): subject
9+
10+
body
11+
12+
footer
13+
```
14+
15+
## Types
16+
17+
- `feat`: A new feature
18+
- `fix`: A bug fix
19+
- `docs`: Documentation changes
20+
- `style`: Code style changes (formatting, missing semi-colons, etc.)
21+
- `refactor`: Code refactoring
22+
- `perf`: Performance improvements
23+
- `test`: Adding or updating tests
24+
- `build`: Changes to build system or dependencies
25+
- `ci`: Changes to CI configuration
26+
- `chore`: Other changes that don't modify src or test files
27+
28+
## Examples
29+
30+
```
31+
docs(readme): add installation instructions
32+
33+
feat(auth): implement JWT authentication
34+
35+
fix(api): resolve null pointer exception in user endpoint
36+
```
37+
38+
## Validation
39+
40+
All commits are validated using commitlint with the conventional config.
41+
See `commitlint.config.js` for configuration details.
42+
43+
## CI Integration
44+
45+
The commitlint validation runs automatically on all pull requests and push events.
46+
Commits that don't follow the conventional format will cause CI to fail.
47+
48+
## Resources
49+
50+
- [Conventional Commits Specification](https://www.conventionalcommits.org/)
51+
- [Commitlint Documentation](https://commitlint.js.org/)
52+
53+
## Note for Contributors
54+
55+
All pull requests must have appropriate labels set for CI to pass. Required labels:
56+
- One from Type: Easy/Medium/Hard
57+
- One from Semver: Major/Minor/Patch
58+
- PR:Accept

.github/COMMIT_HISTORY_NOTE.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Commit History Note
2+
3+
## Commit 5827b78
4+
5+
The commit `5827b78a46e74d34111955ec815b84c5a31fa34f` with message:
6+
"Enhance README with project details and structure"
7+
8+
Should have followed conventional commit format as:
9+
```
10+
docs(readme): add comprehensive project documentation
11+
12+
Added detailed sections covering project overview, vision, goals, features,
13+
tech stack, architecture, testing guidelines, and contribution workflow.
14+
```
15+
16+
This note documents the correct format for reference. Future commits will follow
17+
the conventional commit specification as enforced by commitlint.

.github/workflows/checklabels.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ jobs:
1212
- name: Set up Node.js
1313
uses: actions/setup-node@v3
1414
with:
15-
node-version: 16
15+
node-version: 18
1616
- name: Install dependencies
1717
run: npm install @actions/github @actions/core
1818
- name: Run Label Checker

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)