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

Enhance the README.md file i.e. the documentation #10

Closed
bhatvikrant opened this issue Feb 9, 2020 · 14 comments · Fixed by #58
Closed

Enhance the README.md file i.e. the documentation #10

bhatvikrant opened this issue Feb 9, 2020 · 14 comments · Fixed by #58
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers hacktoberfest help wanted Extra attention is needed

Comments

@bhatvikrant
Copy link
Owner

No description provided.

@bhatvikrant bhatvikrant added documentation Improvements or additions to documentation good first issue Good for newcomers labels Feb 9, 2020
@Levi-Thieme
Copy link

Suggestion: A good thing to include in the README file under the contributors section would be how to execute the tests(npm test). This would prevent contributors from contributing and breaking the tests with their contributions due to not knowing about them or how to execute them.

@bhatvikrant
Copy link
Owner Author

Okay , I will add it in the next release.

@bhatvikrant
Copy link
Owner Author

@Levi-Thieme would you like to be a Collaborator in this repository? Your inputs have really helped and will be valuable in the future also.😀

@Levi-Thieme
Copy link

Yes, that would be great. Thank you!

@dheshanm dheshanm mentioned this issue Mar 16, 2020
Merged
2 tasks
@orimdominic
Copy link
Contributor

Has this issue been resolved?

@bhatvikrant
Copy link
Owner Author

@sudo-kaizen no this is still pending. You can pick it up, if you like.

@debugleader
Copy link
Contributor

Hey, are you still online? @bhatvikrant

@bhatvikrant
Copy link
Owner Author

Hey there @debugleader, yup I am here.

@debugleader
Copy link
Contributor

Please check my PR @bhatvikrant

@bhatvikrant
Copy link
Owner Author

@debugleader I ll review your PR on the weekend. Thanks for the contribution!

@debugleader
Copy link
Contributor

Welcome 😉 Always happy to help!
Please contact me in the future if you need anything. @bhatvikrant

@bhatvikrant bhatvikrant added hacktoberfest enhancement New feature or request help wanted Extra attention is needed labels Sep 30, 2020
@damn-dvlpr
Copy link
Contributor

Hey @bhatvikrant can you please throw some light upon what needs to be enhanced in documentation more elaborately?

@bhatvikrant
Copy link
Owner Author

bhatvikrant commented Oct 4, 2020 •
edited

Hey @bhatvikrant can you please throw some light upon what needs to be enhanced in documentation more elaborately?

Yes sure.

  • You can create a working example (Demo) utilizing the library (codesandbox/ online code sharing platforms are suggested). It could be in Gatsby/Vue/React/ any JS library or framework. This is just to increase working examples.

  • You can also restructure the existing documentation in a better way if you feel that way or add any missing data into the documentation.

  • Discuss any other ideas you have, I am always open to new suggestions!

@damn-dvlpr
Copy link
Contributor

@bhatvikrant I have implemented a new API and added its documentation too, also the readme was missing information about this new property "drive_direction", i have added those too. #57

@sthiepaan sthiepaan mentioned this issue Oct 17, 2020
Merged
10 tasks
@sthiepaan sthiepaan linked a pull request Oct 18, 2020 that will close this issue
♻️ Refactor documentation of the project #58
Merged
10 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers hacktoberfest help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

♻️ Refactor documentation of the project sthiepaan/world-countries-capitals
5 participants
@Levi-Thieme @orimdominic @damn-dvlpr @bhatvikrant @debugleader