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.

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

docs: update README.md with additional docs #70

Merged
merged 1 commit into from
Mar 15, 2025
Merged

docs: update README.md with additional docs #70

merged 1 commit into from
Mar 15, 2025

Conversation

aj3sh
Copy link
Member

@aj3sh aj3sh commented Mar 9, 2025

Description

The purpose of these updates are to provide a quick reference for using Conventional Commits in CI and pre-commit.

  • Update README.md (removed Conventional Commits details)
  • Added additional docs for Conventional Commits and CLI

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
  • Documentation update
  • Refactor
  • Other (please specify)

Checklist

  • My pull request has a clear title and description.
  • I have used semantic commit messages.
    Examples: "fix: Fixed foobar bug", "feat(accounts): Added foobar feature".
  • 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.

@aj3sh aj3sh requested a review from sugat009 March 9, 2025 15:39
Copy link
Contributor

@sugat009 sugat009 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice

@aj3sh aj3sh merged commit bbfa423 into main Mar 15, 2025
4 checks passed
@aj3sh aj3sh deleted the readme branch March 15, 2025 16:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants