Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Enforce Conventional Commits #19

Merged
merged 2 commits into from
Jan 5, 2024
Merged

Enforce Conventional Commits #19

merged 2 commits into from
Jan 5, 2024

Conversation

geoffreyvanwyk
Copy link
Owner

Resolves: #18

@geoffreyvanwyk
build(git): lint commits before creating them
1506d60 
Lint using Commitlint, running via Git hooks installed with Husky. This
was done with the following commands:

```shell
npm install --save-dev @commitlint/{cli,config-conventional}
echo "module.exports = { extends: ['@commitlint/config-conventional'] };" > commitlint.config.js
npm install --save-dev husky
npm pkg set scripts.prepare="husky install"
npm run prepare
npm pkg set scripts.commitlint="commitlint --edit"
npx husky add .husky/commit-msg 'npm run commitlint ${1}'
```

Lint within VS Code using the recommended extension in the .vscode directory.

Issues: #18
@geoffreyvanwyk geoffreyvanwyk force-pushed the support/18-conventional-commits branch 9 times, most recently from 5b3ba90 to a62fcf8 Compare January 5, 2024 04:16
@geoffreyvanwyk
build(ci): lint commits in pull requests
f7c1518 
Prevent the merging of unconventional commits into the master branch.

Lint commits made directly onto the master branch.

Issues: #18
@geoffreyvanwyk geoffreyvanwyk merged commit ca239c2 into master Jan 5, 2024
1 check passed
@geoffreyvanwyk geoffreyvanwyk deleted the support/18-conventional-commits branch January 5, 2024 07:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Enforce conventional commits
1 participant
@geoffreyvanwyk