docs: add Conventional commit message info in README - Githubissues

opensource-nepal / commitlint

commitlint is a tool designed to lint your commit messages according to the Conventional Commits standard for your pre-commit hook and GitHub Actions.

GNU General Public License v3.0

22 stars 9 forks source link

docs: add Conventional commit message info in README #35

Closed aj3sh closed 6 months ago

aj3sh commented 6 months ago

Description

Added information about Conventional commits in the README.
Added header length validation as a Note.
Minor reformatting in README file.

Related Issue

Fixes #30

Type of Change

Please mark the appropriate option below to describe the type of change your pull request introduces:

[ ] Bug fix
[ ] New feature
[ ] Enhancement
[x] Documentation update
[ ] Refactor
[ ] Other (please specify)

Checklist

[x] My pull request has a clear title and description.
[x] I have used semantic commit messages. Examples: "fix: Fixed foobar bug", "feat(accounts): Added foobar feature".
[x] I have added/updated the necessary documentation on README.md.
[ ] I have added appropriate test cases (if applicable) to ensure the changes are functioning correctly.

Additional Notes

[Add any additional notes or context that you think the reviewers should know about.]

By submitting this pull request, I confirm that I have read and complied with the contribution guidelines of this project.