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

Package Documentation #443

Open
abdulrahman19 opened this issue Oct 12, 2020 · 2 comments
Open

Package Documentation #443

abdulrahman19 opened this issue Oct 12, 2020 · 2 comments
Labels
documentation

Comments

@abdulrahman19
Copy link

abdulrahman19 commented Oct 12, 2020 •
edited

Package Documentation

First of all, thanks for all effort in this awesome package.

Can please anyone provides simple & updated documentation for this package, I can't understand many of things, that's will be a great help.
@pelmered
Copy link

Yes, I agree.
The documentation for both the configuration options and how to to interpret the metrics and make them more actionable(How they are measured, and what can you do to improve them) is lacking pretty severely. This limits the value you get from this tool quite a lot.

@abdulrahman19
Copy link
Author

Until documentation is created, I found this course https://open.hpi.de/courses/softwareanalytics2015 It'll help you to understand many things in this package. Less is better than nothing 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@pelmered @niconoe- @abdulrahman19