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

Updating the README file #13

Closed
harshmishra19 opened this issue May 10, 2024 · 7 comments
Closed

Updating the README file #13

harshmishra19 opened this issue May 10, 2024 · 7 comments
Labels

Comments

@harshmishra19
Copy link
Contributor

Hey @ayush-that , I noticed that your README file might not be beginner-friendly enough for newcomers to understand and start contributing. I can assure you that I'll update the README file to make it more beginner-friendly. Could you please assign me this issue under GSSOC'24

@ayush-that ayush-that added documentation Improvements or additions to documentation level1 labels May 11, 2024
@ayush-that
Copy link
Owner

Hi @harshmishra19,
Could you please provide some details on the specific improvements you plan to make?

@ayush-that ayush-that added gssoc and removed documentation Improvements or additions to documentation level1 labels May 11, 2024
@anu906
Copy link

anu906 commented May 11, 2024

Hello @ayush-that , can you assign this task to me.

@ayush-that
Copy link
Owner

Hello @ayush-that , can you assign this task to me.

What improvements would you make the the readme?

@anu906
Copy link

anu906 commented May 11, 2024

  • Information on how people can contribute to the project.
  • Few more descriptions on project idea and steps to fork the repository.
  • Also, to beautify the README file a bit along side to make it user friendly.

Kindly give suggestions on this, if any.
Thank you.

@harshmishra19
Copy link
Contributor Author

@ayush-that
I would like to make the following changes:

  • Provide a brief overview of the importance of financial literacy and how FinVeda addresses this need.
  • Briefly describe each feature, highlighting its purpose and how it benefits users
  • Clearly outline the steps for contributing, including forking the repository, making changes, and submitting a pull request

@harshmishra19
Copy link
Contributor Author

@ayush-that I was the first one to address the issue so could you plz assign this issue to me

@ayush-that
Copy link
Owner

The readme already has how to contribute instructions.
You may submit a PR with your changes if you want.
No points will be given for it.

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

No branches or pull requests

3 participants