diff --git a/.github/COMMIT_CONVENTION.md b/.github/COMMIT_CONVENTION.md new file mode 100644 index 0000000..273c734 --- /dev/null +++ b/.github/COMMIT_CONVENTION.md @@ -0,0 +1,58 @@ +# Commit Message Convention + +This project follows the [Conventional Commits](https://www.conventionalcommits.org/) specification. + +## Format + +``` +type(scope): subject + +body + +footer +``` + +## Types + +- `feat`: A new feature +- `fix`: A bug fix +- `docs`: Documentation changes +- `style`: Code style changes (formatting, missing semi-colons, etc.) +- `refactor`: Code refactoring +- `perf`: Performance improvements +- `test`: Adding or updating tests +- `build`: Changes to build system or dependencies +- `ci`: Changes to CI configuration +- `chore`: Other changes that don't modify src or test files + +## Examples + +``` +docs(readme): add installation instructions + +feat(auth): implement JWT authentication + +fix(api): resolve null pointer exception in user endpoint +``` + +## Validation + +All commits are validated using commitlint with the conventional config. +See `commitlint.config.js` for configuration details. + +## CI Integration + +The commitlint validation runs automatically on all pull requests and push events. +Commits that don't follow the conventional format will cause CI to fail. + +## Resources + +- [Conventional Commits Specification](https://www.conventionalcommits.org/) +- [Commitlint Documentation](https://commitlint.js.org/) + +## Note for Contributors + +All pull requests must have appropriate labels set for CI to pass. Required labels: +- One from Type: Easy/Medium/Hard +- One from Semver: Major/Minor/Patch +- PR:Accept diff --git a/.github/COMMIT_HISTORY_NOTE.md b/.github/COMMIT_HISTORY_NOTE.md new file mode 100644 index 0000000..77daab8 --- /dev/null +++ b/.github/COMMIT_HISTORY_NOTE.md @@ -0,0 +1,17 @@ +# Commit History Note + +## Commit 5827b78 + +The commit `5827b78a46e74d34111955ec815b84c5a31fa34f` with message: +"Enhance README with project details and structure" + +Should have followed conventional commit format as: +``` +docs(readme): add comprehensive project documentation + +Added detailed sections covering project overview, vision, goals, features, +tech stack, architecture, testing guidelines, and contribution workflow. +``` + +This note documents the correct format for reference. Future commits will follow +the conventional commit specification as enforced by commitlint. diff --git a/.github/workflows/checklabels.yaml b/.github/workflows/checklabels.yaml index 1b752ff..2c50bf0 100644 --- a/.github/workflows/checklabels.yaml +++ b/.github/workflows/checklabels.yaml @@ -12,7 +12,7 @@ jobs: - name: Set up Node.js uses: actions/setup-node@v3 with: - node-version: 16 + node-version: 18 - name: Install dependencies run: npm install @actions/github @actions/core - name: Run Label Checker diff --git a/package-lock.json b/package-lock.json index 300a1b2..0648d61 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,5 +1,5 @@ { - "name": "template", + "name": "PeerCall", "lockfileVersion": 3, "requires": true, "packages": {