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

Update README.md and Contributor section #82 #84

Merged
merged 1 commit into from
Oct 14, 2024

Conversation

AnushkaChouhan25
Copy link
Contributor

@AnushkaChouhan25 AnushkaChouhan25 commented Oct 14, 2024

Description

This PR updates the README file to improve clarity and provide detailed instructions for contributors.
-This PR does the following:
-Adds a section for contributing guidelines.
-Fixes outdated information regarding the installation process.
-Updates the contact information and links to related resources.

Related Issues

Changes

List the detailed changes made in this PR.
-Added a new section outlining how to contribute to the project.
-Refactored the installation instructions for better clarity and accuracy.
-Fixed the outdated links to resources and contact information.

Testing Instructions

Detailed instructions on how to test the changes. Include any setup needed and specific test cases.

  1. Pull this branch.
  2. Run npm install to install dependencies.
  3. Run npm test to execute the test suite.
  4. Verify that all links are functional and direct to the correct resources.

Screenshots (if applicable)

image

image

Additional Context

  • This PR is based on feedback from the community and aims to enhance the onboarding experience for new contributors.

Checklist

  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • My changes generate no new warnings
  • I am working on this issue under GSSOC

Copy link

vercel bot commented Oct 14, 2024

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

Name Status Preview Comments Updated (UTC)
wanderlust-2024 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 14, 2024 9:37am

Copy link

Thank you for submitting your pull request! 🙌 We'll review it as soon as possible. In the meantime, please ensure that your changes align with our CONTRIBUTING.md. If there are any specific instructions or feedback regarding your PR, we'll provide them here. Thanks again for your contribution! 😊

@AnushkaChouhan25
Copy link
Contributor Author

Please assign this under gssoc-extd, hactoberfest and hactoberfest-accepted. Thank you! @Soujanya2004

@Soujanya2004 Soujanya2004 merged commit f56510b into Soujanya2004:main Oct 14, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Documentation Update]: Update README for Enhanced Appeal and Contributor Section
2 participants