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: Created a contributing.md file #10

Closed
wants to merge 1 commit into from
Closed

docs: Created a contributing.md file #10

wants to merge 1 commit into from

Conversation

0nikhilkumar
Copy link

@0nikhilkumar 0nikhilkumar commented Oct 7, 2023

What does this PR do?

Created a CONTRIBUTING.md

Fixes #5

1
2
3
4

Type of change

This is adding a contributing.md file which is docs category issue

How should this be tested?

  • Are there environment variables that should be set?
  • What are the minimal test data to have?
  • What is expected (happy path) to have (input and output)?
  • Any other important info that could help to test that PR

Mandatory Tasks

  • Make sure you have self-reviewed the code. A decent size PR without self-review might be rejected.

Checklist

  • My code doesn't follow the style guidelines of this project
  • I haven't commented my code, particularly in hard-to-understand areas
  • I haven't checked if my PR needs changes to the documentation
  • I haven't checked if my changes generate no new warnings
  • I haven't added tests that prove my fix is effective or that my feature works
  • I haven't checked if new and existing unit tests pass locally with my changes

@github-actions
Copy link

github-actions bot commented Oct 7, 2023

Thank you for following the naming conventions! 🙏

@piyushgarg-dev
Copy link
Owner

Hi @0nikhilkumar, Thanks for contributing. I am closing this PR in favor of #8 😄.
Please feel free to open a new issue and PR to add more content to existing Contributing and Readme File.

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.

Create CONTIBUTING.md
2 participants