Skip to content
This repository has been archived by the owner on Apr 5, 2022. It is now read-only.

New Metrics: Support of source code related metrics #139

Closed
inishchith opened this issue Apr 19, 2019 · 8 comments
Closed

New Metrics: Support of source code related metrics #139

inishchith opened this issue Apr 19, 2019 · 8 comments

Comments

@inishchith
Copy link

After the ideation of adding support to GrimoireLab to produce source code related metrics using Graal was introduced in chaoss/grimoirelab#182 and supporting discussion thread chaoss/grimoirelab#182 (comment) and a response chaoss/grimoirelab#182 (comment). I had some thoughts to get the discussion started here in order to understand the current state and future scope of additions of metrics.


Some of the ideas aligned were:

  1. License & Copyright analysis related

    • All licenses: List of licenses present in the repository.
    • License Count: Number of licenses found in a software repository.
    • Package License Declaration: A list of license declarations on the software
      package.
    • Copyright Declaration: The degree to which the project properly declares
      copyright details.
    • License Coverage: Number of files with a file notice (copyright notice + license
      notice) and ones without a file notice.
  2. Code complexity analysis related ( cyclomatic complexity, LOC )

    • LOC: Total Lines of Code
    • CCN: Cyclomatic Code Complexity of a software repository.
    • Complex Files: A list of files with higher complexity in terms of Cyclomatic Code
      Complexity (CCN) & Lines of Code (LOC).
    • Functions: Number of functions
    • Comments: Total comment lines present in the repository.

Would like to know if this is the right place for the discussion.
I'd be more than happy to join a call for the discussion :)
Would also like to have some pointers from @jgbarah @valeriocos @aswanipranjal

Thanks

@valeriocos
Copy link
Member

Thank you @inishchith for triggering the discussions about code related metrics. Overall they look OK, find below some comments for each idea.

  1. License & Copyright analysis related

Possible additions to the proposed list could be:

  • the list of files without a license (this could be useful to drive improvements to increase the license coverage)
  • License Coverage at package/folder level
  1. Code complexity analysis related ( cyclomatic complexity, LOC )

It could be interesting to apply the same metrics also at package level. This info could be useful to drive refactorings.

@inishchith
Copy link
Author

inishchith commented Apr 20, 2019

@valeriocos Thanks for suggesting the improvements, Overall I like the ideas. We can prioritize their implementation accordingly. I'll update the thread in case of refinements to the initially suggested ideas.
I'm unsure how we proceed from here.

@GeorgLink @jgbarah Can you please have a look

Thanks.

@jgbarah
Copy link
Contributor

jgbarah commented Apr 22, 2019

I like the idea, but I'm not sure how to convey it. We have some working groups potentially involved... Maybe the best thing could be one of these:

  • Deal with these metrics in the context of the Evolution (formerly GMD) working group, likely in the context of the code development focus area.

  • Deal with these metrics here, and then each wg can decide which ones to pick up for their focus areas...

@germonprez @GeorgLink any feedback about this?

@GeorgLink
Copy link
Member

Thanks @inishchith for kicking off the discussion.

I agree with @jgbarah, any WG can pick up a metric they are interested in.

The Common, Risk, or Evolution Working Groups are good places to advance these metrics. I suggest you see which WG is most interested and advance the metrics there.

@inishchith
Copy link
Author

@jgbarah @GeorgLink Thanks for the suggestions :)
I'd like to get involved with the discussion for the same in case it's conducted in the weekly meetings if possible. I'm unaware of the schedule of the meetings though. Please do let me know.

Thanks

@GeorgLink
Copy link
Member

Schedule of meetings: https://chaoss.community/participate/

Please let me know if you have any questions about the meetings or the page I directed you to.

@inishchith
Copy link
Author

inishchith commented Apr 25, 2019

@GeorgLink Thanks for the response.
I'll surely try and join the upcoming meetings :)

@germonprez
Copy link
Contributor

Issue resolved.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants