docs: update usage information for v1 - 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

16 stars 9 forks source link

docs: update usage information for v1 #45

Closed aj3sh closed 4 months ago

aj3sh commented 4 months ago

Description

This PR is for readiness for v1 release.

Updated version information on docs and example actions.
Refactored example usage syntax
Renamed test_action.yaml to commitlint.yaml so user can take a reference as mentioned in the docs.

Related Issue

N/A

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.