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.

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

Impact Ratio as a new metric #226

Open
yegor256 opened this issue Mar 21, 2024 · 6 comments
Open

Impact Ratio as a new metric #226

yegor256 opened this issue Mar 21, 2024 · 6 comments
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@yegor256
Copy link
Owner

Let's add a series of new metrics:

  • Impact Ratio (IR): 1 divided by the total number of Java files in the entire repository
  • Impact Ratio by Lines of Code (IRLoC): number of lines of code in a file divided by the total number of lines of code in the entire repository
  • Impact Ratio by Commits (IRC): number of Git commits made in a file divided by the total number of Git commits in the entire repository
  • Impact Ratio by Commit Authors (IRCA): number of Git committers who made changes in a file divided by the total number of Git committers in the entire repository
@yegor256 yegor256 added enhancement New feature or request help wanted Extra attention is needed labels Mar 21, 2024
@zaqbez39me
Copy link
Contributor

@yegor256 should we count LOC only in *.java files for all the metrics here?

@yegor256
Copy link
Owner Author

@zaqbez39me yes, of course. There are no other files available in the dataset, when metric calculation starts.

@zaqbez39me
Copy link
Contributor

@yegor256 Should we split this task on several PRs? I mean, each subtask test and implementation should be in separate PRs, or all tests in first PR and all the code in second PR?

@yegor256
Copy link
Owner Author

@zaqbez39me definitely, would be better to do this in a number of PRs. I would suggest to start from tests.

@zaqbez39me
Copy link
Contributor

@yegor256 In IRLoC, IRC and IRCA we have repo and some file. Do repo and file paths should be provided separately to the script? If yes, should we check that the file is a part of a given repo? If no, should we change dir to parent of the given file and call there all the git commands needed?

@yegor256
Copy link
Owner Author

yegor256 commented Apr 5, 2024

@zaqbez39me I think, we can find the "root" directory of the repo by looking for the .git location in upper directories, until we find it. WDYT?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants