Feat: Set up commitlint & commitizen - Githubissues

nishiki-tech / nishiki-frontend

Nishiki is an app for tracking and sharing food inventories within groups for better pantry management.

https://nishiki.tech

MIT License

21 stars 5 forks source link

Feat: Set up commitlint & commitizen #111

Closed nick-y-ito closed 10 months ago

nick-y-ito commented 10 months ago

Overview

This PR introduces commitlint and commitizen.

Changes

Installed and set up commitlint, following the official setup instruction.
Installed and set up commitizen, following the official document
Updated the "Commit Convention" section of CONTRIBUTING.md because some prefixes were missing.

Review points

You can confirm that commitlint works by executing (expected to fail):
```
git commit -m "foo: this will fail" --allow-empty
```
You can confirm that commitizen works by running the regular git commit command (See the video below)

Screen Captures

How commitizen works:

https://github.com/genesis-tech-tribe/nishiki-frontend/assets/99148565/3801f4e1-eb0d-4770-9766-a18031e8690c

Note

commitizen only works in the CLI
Prompts of commitizen can be modified by installing additional packages, such as cz-customizable
You may want to use the VS Code extension commitlint

Assignee Checklist:

[x] The base branch is correct (See: Types of Branches)
[x] The branch name follows the Branch Naming Conventions
[x] The correct assignees and reviewers have been designated for this PR
[x] The coding style follows the Coding Style Guide
[x] All the related issues are associated with this PR
[x] All criteria in the associated issues are met (please tick the checkboxes)
[x] My changes do not generate new warnings or errors (especially in the console)

Reviewer Checklist:

[x] The code follows the generic best practices and our Coding Style Guide
[x] The code is well-commented and easy to understand
[x] UI changes accurately reflect the provided design

nick-y-ito commented 10 months ago

@kanta1207 @kotaaaa Thank you for your reviews!