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 contributing guidelines with example script #98

Merged
merged 1 commit into from
Dec 20, 2024

Conversation

aj3sh
Copy link
Member

@aj3sh aj3sh commented Dec 17, 2024

Description

  • Updated CONTRIBUTING.md with more examples.
  • Created example.ts and added npm script npm run example to run the example

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

  • 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.
  • My pull request has a clear title and description.

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 kvr24611 December 17, 2024 16:39
package.json Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
kvr24611
kvr24611 previously approved these changes Dec 19, 2024
Copy link
Collaborator

@kvr24611 kvr24611 left a comment

Choose a reason for hiding this comment

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

The information in the guideline is to the point and grammatically correct. I also followed along the instructions and they are well explaining.

@aj3sh
Copy link
Member Author

aj3sh commented Dec 19, 2024

The information in the guideline is to the point and grammatically correct. I also followed along the instructions and they are well explaining.

Thanks @kvr24611 for your review. Really appreciated. 🙂

@kvr24611 kvr24611 merged commit 4558275 into main Dec 20, 2024
3 checks passed
@kvr24611 kvr24611 deleted the contributing branch December 20, 2024 05:57
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.

3 participants