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: #5 Created a CONTRIBUTING.md and #6 Added a README.md #8

Merged
merged 11 commits into from
Oct 7, 2023

Conversation

priyankeshh
Copy link
Contributor

@priyankeshh priyankeshh commented Oct 7, 2023

What does this PR do?

-Created a CONTRIBUTING.md (Issue #5)
-Added a README.md (Issue #6)
-Made and Added a logo in README.md #6

Fixes # (issue)

Requirement/Documentation

  • If there is a requirement document, please, share it here.
  • If there is ab UI/UX design document, please, share it here.

Type of change

  • This change requires a documentation update

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! 🙏

@priyankeshh priyankeshh changed the title #5 Created a CONTRIBUTING.md and #6 Added a README.md docs: #5 Created a CONTRIBUTING.md and #6 Added a README.md Oct 7, 2023
@priyankeshh
Copy link
Contributor Author

@piyushgarg-dev , I've added a contribution guide (CONTRIBUTING.md) following the guidelines I found in your video. Could you please review it and let me know if it's okay, or if there are any changes or additional information you'd like me to include? Your feedback would be greatly appreciated. Thank you!

@piyushgarg-dev
Copy link
Owner

Great Job 🎉

@piyushgarg-dev piyushgarg-dev added documentation Improvements or additions to documentation hacktoberfest Hacktoberfest Accepted Issues hacktoberfest-accepted Hacktoberfest Accepted labels Oct 7, 2023
@piyushgarg-dev piyushgarg-dev merged commit 425533a into piyushgarg-dev:main Oct 7, 2023
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation hacktoberfest Hacktoberfest Accepted Issues hacktoberfest-accepted Hacktoberfest Accepted
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants