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

Add a better README.md #42

Closed
ritwikshanker opened this issue Oct 10, 2020 · 10 comments · Fixed by #72
Closed

Add a better README.md #42

ritwikshanker opened this issue Oct 10, 2020 · 10 comments · Fixed by #72
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest PR for hacktoberfest help wanted Extra attention is needed

Comments

@ritwikshanker
Copy link
Owner

ritwikshanker commented Oct 10, 2020

  • The current readme.md is very poor looking with no images and bad formatting.
  • Repo doesn't have a good cover image too.
  • No app screenshots present
  • demo.gif is of old version (I'll give you a new one)
  • Merging contribution guidelines to project readme
  • Adding Version Changelog to readme
@ritwikshanker ritwikshanker added documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest PR for hacktoberfest labels Oct 10, 2020
@ritwikshanker ritwikshanker changed the title Add a better Readme Add a better readme.md Oct 10, 2020
@ritwikshanker ritwikshanker changed the title Add a better readme.md Add a better GoCoronaGo/README.md Oct 10, 2020
@ritwikshanker ritwikshanker changed the title Add a better GoCoronaGo/README.md Add a better /README.md Oct 10, 2020
@ritwikshanker ritwikshanker changed the title Add a better /README.md Add a better README.md Oct 10, 2020
@ritwikshanker ritwikshanker added the help wanted Extra attention is needed label Oct 10, 2020
@github-actions
Copy link

Stale issue message

@AkshaiBaruah
Copy link
Contributor

Sir I would like to work on this Issue.
Also if it's okay then I would also like to add a guide to make PR for hacktoberfest at the end of readme

@ritwikshanker
Copy link
Owner Author

Sure @AkshaiBaruah
I've assigned you this issue. For this, you can directly raise your PR to the master branch.

@AkshaiBaruah
Copy link
Contributor

Can you provide me with the new demo.gif

@ritwikshanker
Copy link
Owner Author

Hey, @AkshaiBaruah Actually I had added the new gif a few months back when this issue went stale. You can use the current gif present in the readme.

@ritwikshanker
Copy link
Owner Author

@AkshaiBaruah Are you still working on this? If not I'll have to re assign the issue to someone else.

@gururani-abhishek
Copy link
Contributor

gururani-abhishek commented Oct 12, 2021

I would like to work on this, but I've got a few questions. Regarding your given 6 points :

  1. Will format README.md but too many images will make it extra long and dull, as we already have a gif.
  2. You'll provide with the cover image, I guess!
  3. Too many screenshots will make it dull, or we can decrease the size of gif using markdown(I guess that's possible?) and then add 2 screenshots.
  4. Please elaborate 6th point.

@ritwikshanker
Copy link
Owner Author

  1. Yeah GIF is already updated. We can skip images.
  2. As of now, I've not designed any cover Image. If you want you can design else I'll accept your PR without that too.
  3. We can proceed without Screenshots
  4. For every update we publish a changelog, I meant that we can include that in the main readme. (Not necessary since now Github release page has changed a lot and has more readability)

@gururani-abhishek
Copy link
Contributor

great, would love to work on it.

@gururani-abhishek
Copy link
Contributor

I've made a PR, do check :)

@ritwikshanker ritwikshanker linked a pull request Oct 12, 2021 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest PR for hacktoberfest help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants