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

Created dedicated Contributing.md file & Updated README.md with Team Section and redirect. #110

Merged
merged 11 commits into from
Oct 6, 2024

Conversation

rajdeepchakraborty-rc
Copy link
Contributor

Description

This pull request aims to enhance the documentation and accessibility for contributors by providing a separate Contributing.md file, which offers a brief walkthrough to guide them in contributing to the project. It also modifies the README.md file by adding the following changes(screenshots provided below in the PR).

Related Issue

Link to the issue this PR addresses (if applicable):

Type of Change

  • Bug fix
  • New feature
  • Documentation update
  • Other (please describe):

Checklist

  • I have read the contributing guidelines.
  • I have followed the code style of this project.
  • My code implements the changes requested in the issue.
  • I have added tests to cover my changes (if applicable).
  • I have updated the documentation (if necessary).
  • This PR is ready for review.

Screenshots:

Before:

  • This was the previous README.md file
    image
    image

After:

  • These are the modified sections of README.md file contributed by me
    image
    image

  • This is the newly created Contributing.md file for the Contributors.
    image
    image

Additional Notes

In addition to creating the Contributing.md file, I have also added a redirect link in the README.md file(Contributing Section) to guide contributors to the Contributing.md file after they finish reading the README.md. I have also changed the name to QR Code Generator in the README.md file as discussed in the issue discussion.

Thank you for reviewing my pull request!

Copy link

vercel bot commented Oct 6, 2024

@rajdeepchakraborty-rc is attempting to deploy a commit to the Akshay Patel's projects Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

🎉 Thank you for your contribution! Your pull request has been submitted successfully. A maintainer will review it as soon as possible. We appreciate your support in making this project better

@rajdeepchakraborty-rc
Copy link
Contributor Author

rajdeepchakraborty-rc commented Oct 6, 2024

@VesperAkshay Please look into the PR and add necessary labels:

  • level (level1 or level2 or level3)
  • gssoc-ext
  • hactoberfest-accepted

Copy link

vercel bot commented Oct 6, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
qr-code-generator ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 6, 2024 3:48pm

@VesperAkshay VesperAkshay merged commit bd47284 into VesperAkshay:main Oct 6, 2024
3 of 4 checks passed
@rajdeepchakraborty-rc
Copy link
Contributor Author

@VesperAkshay thanks for reviewing the PR. Also please assign the PR to me.

@rajdeepchakraborty-rc
Copy link
Contributor Author

Thank you!

@rajdeepchakraborty-rc
Copy link
Contributor Author

rajdeepchakraborty-rc commented Oct 6, 2024

@VesperAkshay This should be assigned level 2
image
Please update it and let the GSSoC team know about the change for the points calculation.

@rajdeepchakraborty-rc
Copy link
Contributor Author

Thank You!

@rajdeepchakraborty-rc rajdeepchakraborty-rc deleted the contributing branch October 6, 2024 20:47
@sanjay-kv
Copy link

@VesperAkshay the level label is wrong it should be level2 without space.
kindly add me into the repo

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOCS] Creation of dedicated Contributing.md file & Updation of README.md(Design)
3 participants