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

Edit the documentation of github-analyzer #10

Open
shashank-sharma opened this issue Dec 14, 2019 · 0 comments
Open

Edit the documentation of github-analyzer #10

shashank-sharma opened this issue Dec 14, 2019 · 0 comments
Labels
documentation Improvements or additions to documentation easy Extra attention is needed good first issue Good for newcomers

Comments

@shashank-sharma
Copy link
Member

Right now README.md file is not that helpful for example:

  1. What is this module
  2. Why we doing it
  3. How to install
  4. Screenshots
  5. Requirements
@shashank-sharma shashank-sharma added documentation Improvements or additions to documentation good first issue Good for newcomers easy Extra attention is needed labels Dec 14, 2019
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 easy Extra attention is needed good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@shashank-sharma