Creating Shannon Entropy calculation function and editing test datasets

[willdavidson05]

Description

This PR introduces an entropy.py module that computes the Shannon Entropy, based on the output from (calculate_loc_changes) in git_parser.py.

Within the module, safeguards were used to ensure that probability values cannot be negative. Additionally, a test suite test_entropy.py has been created to validate against negative outputs.

The test datasets were edited to have multiple files in a repository, this is done in the high_entropy repo. To support repositories with multiple files, modifications were made to (calculate_loc_changes) in git_parser.py. It now accepts an additional parameter, file_names: list[str].

A PR has been created to work on refining the test repositories, as well as the expanding on the testing suites, referenced here #69

I appreciate any comments or feedback!

Closes #62 , #64

What is the nature of your change?

• Content additions or updates (adds or updates content)
• Bug fix (fixes an issue).
• Enhancement (adds functionality).
• Breaking change (these changes would cause existing functionality to not work as expected).

Checklist

Please ensure that all boxes are checked before indicating that this pull request is ready for review.

• I have read the CONTRIBUTING.md guidelines.
• My code follows the style guidelines of this project.
• I have performed a self-review of my own contributions.
• I have commented my content, particularly in hard-to-understand areas.
• I have made corresponding changes to related documentation (outside of book content).
• My changes generate no new warnings.
• New and existing tests pass locally with my changes.
• I have added tests that prove my additions are effective or that my feature works.
• I have deleted all non-relevant text in this pull request template.

[d33bs]

Nice work! I left a few comments and suggestions throughout this review. Please don't hesitate to let me know if you have any questions.

[d33bs]

Consider adding a comparison for high entropy vs low entropy with an additional assert below (should one be higher than the other)?

[willdavidson05]

Referenced in test dataset issue

[d33bs]

Consider adding another check to make sure that the file sets are different from one another.

[willdavidson05]

Referenced in test dataset issue

[willdavidson05]

Thank you for the review, @d33bs! Following your feedback on the test datasets, along with my own concerns, I've created a new PR (#69) to address many of the issues. Any comments you made regarding testing suites or the setup of repositories were referenced in issue #66. Your other feedback has been implemented, and I have left a question for you above!

[d33bs]

Looks great, thanks for addressing all those comments. I left a couple additional thoughts. Looking forward to the changes in #69 . Feel free to merge when you feel things are ready.