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

Enhancing Readme.md file #17

Closed
neeru24 opened this issue Oct 9, 2024 · 2 comments
Closed

Enhancing Readme.md file #17

neeru24 opened this issue Oct 9, 2024 · 2 comments

Comments

@neeru24
Copy link

neeru24 commented Oct 9, 2024

Hi,

I noticed the project is missing a README.md file. I would like to contribute by creating a comprehensive README.md that includes:

  1. Project Overview: A brief description of the project, its purpose, and key features.

  2. Installation Instructions: Step-by-step instructions on how to clone the repository and set up the project locally.

  3. Usage Guide: How to use the features of the project, including examples where applicable.

  4. Contributing Guidelines: Instructions on how others can contribute to the project.

  5. License Information: Details about the project's license, if applicable.

I will submit a pull request within 1 or 2 hours of being assigned this issue. Could you kindly assign me this task? I’d love to help improve the documentation.

Thank you!

@Prithwi32
Copy link
Collaborator

@neeru24 Thank you for raising issue, but for now this issue already raised by other person, so kindly wait if other fails to complete PR, otherwise u can raise new issue

@neeru24
Copy link
Author

neeru24 commented Oct 10, 2024

@neeru24 Thank you for raising issue, but for now this issue already raised by other person, so kindly wait if other fails to complete PR, otherwise u can raise new issue

Btw that issue was opened one week ago and it has been so long. Could you just assign me also? I'll submit a PR by tonight with a well structured Readme.

image

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

No branches or pull requests

2 participants