Skip to content

V4.0 - Adding my Forked CK Project as a Submodule of the Worked-Example-Miner Tool
Compare
Choose a tag to compare
@BrenoFariasdaSilva BrenoFariasdaSilva released this 04 Oct 11:43
· 1089 commits to main since this release
v4.0
3102dba

Release 4.0 - Adding my Forked CK Project as a Submodule of the Worked-Example-Miner Tool

Key Changes:

Refactoring Improvements:

  • Enhanced the calculation of the Percentual Change Value to range between 0-100 with two decimal precision.
  • Improved the overall structure of the Metrics Changes and Code Metrics Python files for better readability and maintainability.
  • Eliminated redundant calculations and optimized function definitions to enhance performance.

Feature Additions:

  • Implemented the deletion of the old substantial changes file during the first substantial change verification.
  • Introduced new constants for paths related to RefactoringMiner refactorings.
  • Added functions to generate refactoring files and validate paths for the RefactoringMiner tool.
  • Integrated a mechanism for PyDriller to automatically retrieve commit counts for repositories.
  • Added the VERBOSE output constant across various Python files for better debugging information.

Documentation Updates:

  • Transitioned from JavaDoc to Python docstrings in multiple files for improved documentation practices.
  • Enhanced comments throughout the codebase to provide clearer explanations of functionalities and processes.
  • Introduced a CONTRIBUTING file to guide new contributors on how to engage with the project.

Makefile Enhancements:

  • Updated the Makefile to utilize a Requirements.txt for managing dependencies.
  • Added rules for generating the Requirements.txt for both PyDriller and RefactoringMiner directories.

License Addition:

  • Included the Apache-2.0 license file to formalize the project’s licensing structure.

Refactoring:

  • Various files and functions were renamed to follow Python naming conventions, enhancing clarity (e.g., renaming extractZipFiles to extract_zip_files).
  • Enhanced output messages for all major functions to improve user feedback during execution.

Version Control and Recovery:

  • Recovered missed files through the use of Git rebase to ensure all relevant changes are incorporated.

Summary of Commits:

  • Refactors focused on code quality, readability, and efficiency.
  • Features added to improve functionality and user interaction.
  • Documentation updates for clarity and contribution guidelines.
  • Licensing formalities to ensure compliance and openness.

This release marks a significant step forward in integrating the forked CK project into the Worked-Example-Miner tool, providing enhanced metrics capabilities and improved usability for contributors and users alike.

Full Changelog: v3.3...v4.0

Assets 2
Loading