[Feature] Post-GSoC ’24: Enhance Readability of Codebase and Generated Reports

[naishasinha]

Context

Automating Quantifying the Commons was a project endeavor for the Google Summer of Code 2024 program, in which a baseline automation software for data gathering, processing, and analysis was successfully developed. However given the time and resource constraints that we had to consider, there are still addressable endeavors to improve this codebase over the upcoming quarters and years. This is the second (2) of five (5) issues raised specifically for post-GSoC contributions.

Problem

As the post-automation codebase is currently at a baseline stage, the codebase and generated reports can be improved visually for both developers and users (ex. cleaning up comments, report labels, etc.).

Description

This feature involves cleaning up the codebase where necessary, including removing unnecessary comments, shortening report labels, and optimizing the codebase for clarity. By improving readability, the code will be easier to maintain and understand.

As an example:

• The current report labels look like this: https://creativecommons.org/licenes/by/2.5
• Instead, they could be improved to: CC BY 2.5

Implementation

• I would be interested in implementing this feature.