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

revamping README.md for better documentation #30

Closed
VivanVatsa opened this issue Mar 18, 2021 · 2 comments
Closed

revamping README.md for better documentation #30

VivanVatsa opened this issue Mar 18, 2021 · 2 comments

Comments

@VivanVatsa
Copy link

VivanVatsa commented Mar 18, 2021

greetings, as a contributor for GSSOC'21
I would like to revamp the README.md documentation for clarity with better information & grammar.
what will my contribution focus on:

  • proper structured format for easy navigation (links and flow of interaction
  • add dynamic visualization to the readme (gifs & image media)
  • better links presentation
  • categorized heading and sub-heading for clarity
  • contributors highlight
  • installation guides (how to's, do's & don'ts)
  • open-source contribution procedures (forking, committing, branch checkouts, etc)

will get started, once this issue #30 is assigned.

@KajalSinghBAGHEL
Copy link

I am GSSOC participate can i work on this issue

@VivanVatsa
Copy link
Author

@KajalSinghBAGHEL
Most probably this project is out from the GSSOC project list. it's won't be worth the shot.
look for other projects!

regards.

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