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 usage information for v1 #45

Merged
merged 1 commit into from
May 24, 2024

Conversation

aj3sh
Copy link
Member

@aj3sh aj3sh commented May 24, 2024

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
  • 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 review from sugat009 and golesuman May 24, 2024 12:38
@aj3sh aj3sh merged commit 84bced3 into opensource-nepal:main May 24, 2024
3 checks passed
@aj3sh aj3sh deleted the readme-1.0.0 branch July 18, 2024 03:14
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