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

Documentation can be further added and improved #1

Open
Git-Harshit opened this issue Sep 9, 2020 · 3 comments
Open

Documentation can be further added and improved #1

Git-Harshit opened this issue Sep 9, 2020 · 3 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers open for all Open for everyone up-for-grabs Available

Comments

@Git-Harshit
Copy link
Owner

Git-Harshit commented Sep 9, 2020 •
edited
Loading

The current documentation for this repository in README.md and Contributing.md files is currently limited, and has a vast scope of additions, modifications and further improvisations. The documentation improvements would allow addressing as well as covering entire details for later reference. Improvements, complaints, translations as well as suggestions for the same are welcome.

Some reformattings, visual tweaks, content translation (preferrably in a new file), and additions
of new but relevant badges and emojis are also among a lot of doables for MarkDown files in the repository.

Alongside, any additional documentation (example: Code of Conduct), if needed, can be proposed as new MarkDown (*.md) files.
@Git-Harshit Git-Harshit added documentation Improvements or additions to documentation good first issue Good for newcomers labels Sep 9, 2020
@issue-label-bot
Copy link

Issue-Label Bot is automatically applying the label feature_request to this issue, with a confidence of 0.96. Please mark this comment with 👍 or 👎 to give our bot feedback!

Links: app homepage, dashboard and code for this bot.

@Git-Harshit Git-Harshit added up-for-grabs Available open for all Open for everyone labels Sep 9, 2020
@Git-Harshit Git-Harshit pinned this issue Sep 9, 2020
@Git-Harshit Git-Harshit added the hacktoberfest Open Source Contribution atleast for October label Oct 1, 2020
@thesauravkarmakar
Copy link
Contributor

I would like to help you in this

@Git-Harshit
Copy link
Owner Author

Sure @thesauravkarmakar, go for it!

@Git-Harshit Git-Harshit unpinned this issue Oct 2, 2020
@Git-Harshit Git-Harshit removed the hacktoberfest Open Source Contribution atleast for October label Nov 1, 2020
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 good first issue Good for newcomers open for all Open for everyone up-for-grabs Available
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@thesauravkarmakar @Git-Harshit