V3.3 - Sorting the candidates by Percentual Variation of the metric between iterations
Release 3.3 - Sorting the Candidates by Percentual Variation of the Metric Between Iterations
The 3.3 release introduces significant enhancements aimed at improving the code structure and functionality of the PyDriller project. This release focuses on refining the metrics calculation and sorting mechanisms, allowing for a more efficient analysis of candidate variations over iterations. Below are the key changes made in this release:
Key Changes
Refactoring
-
Progress Output Messages: The resuming progress output messages in
PyDriller/Code_Metrics.py
have been updated for better clarity and user experience. (Commit:2023-11-03
) -
Code Style Improvements: Standardization of string delimiters was implemented by updating single quotes to double quotes across the
PyDriller/code_metrics.py
file. (Commits:2023-11-06
) -
Background Color Updates: The background colors for various components, including the Python algorithm and scientific research scripts, have been updated to enhance visual consistency. (Commits:
2023-11-11
) -
Play Sound Feature: The code for the "Play Sound At Exit" feature was refined for better functionality. (Commit:
2023-11-12
) -
README Updates: The Skills List, License Section, and several new sections (Directories, Tools, Repositories, and Methodology) were added and updated in the
README.md
to provide clearer documentation and guidance for users. (Commits:2023-12-12
) -
Makefile Improvements: The Makefile has been updated to ensure correct functionality and to remove unnecessary dependencies. (Commits:
2024-01-30
,2024-03-06
)
New Features
-
Commit Tracking Enhancements: The addition of commit order numbers and hashes to the CSV for the Substantial Changes Detector allows for better tracking of changes over time. (Commit:
2024-03-11
) -
Ignore Keywords Implementation: The ability to ignore certain keywords for class names or variable attributes was added to enhance the Substantial Changes Identifier functionality. (Commit:
2024-03-11
) -
Percentual Change Calculation: A new feature was introduced to improve the percentual change value calculation, ensuring it falls within a 0-100 range with two decimal places, enhancing accuracy in metrics evaluation. (Commit:
2024-03-11
)
Bug Fixes
- Commit Number Retrieval: Resolved an issue with retrieving the commit number from the commit hash, ensuring accurate data representation. (Commit:
2024-03-11
)
Documentation Improvements
- Metrics_Track_Record Documentation: Comprehensive explanations of the
Metrics_Track_Record
dictionary values and structure were added to improve understanding and usability. (Commit:2024-03-05
)
Conclusion
With these updates, release 3.3 not only improves the overall code quality and documentation of the PyDriller project but also enhances the user experience by refining metrics calculations and providing better tracking capabilities. These changes pave the way for more effective analysis and utilization of metrics in Python projects.
Full Changelog: v3.2...v3.3