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.

Sign up for GitHub

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

Jump to bottom

Project lacks good documentation. #55

Open
akshat157 opened this issue Oct 28, 2021 · 2 comments
Open

Project lacks good documentation. #55

akshat157 opened this issue Oct 28, 2021 · 2 comments
Labels
good first issue Good for newcomers hacktoberfest Open for contributions during Hacktoberfest! help wanted Extra attention is needed

Comments

@akshat157
Copy link
Owner

The README.md is getting outdated with time. It also lacks some fundamental information like the title of the project, the application address: https://akshat157.github.io/meditate-app. The information written on it can also be rephrased.

It would be great if the app can be documented well in the README.md. The points mentioned in the previous paragraph are essential requirements, and also, you should keep the Acknowledgements section as much intact as possible.
@akshat157 akshat157 added good first issue Good for newcomers hacktoberfest Open for contributions during Hacktoberfest! help wanted Extra attention is needed labels Oct 28, 2021
@akshat157 akshat157 changed the title This project lacks documentation. Project lacks documentation. Oct 28, 2021
@akshat157 akshat157 changed the title Project lacks documentation. Project lacks good documentation. Oct 28, 2021
@ZaidMarrie
Copy link
Contributor

May I work on this

@akshat157
Copy link
Owner Author

@ZaidMarrie Sure!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good for newcomers hacktoberfest Open for contributions during Hacktoberfest! help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@akshat157 @ZaidMarrie