Skip to content

Conversation

@oree-xx
Copy link
Contributor

@oree-xx oree-xx commented Jan 7, 2026

Fixes

Description

  1. Added prefix to determine sections and entry better.
  2. Improved the update_readme function to insert report sections in alphabetical order.
  3. Updated the check_for_data_files function to check if processed files have been generated previously to avoid regeneration by listing all file paths under constants and calling function in main().
  4. Defined the section_order function to list all report path.
  5. Added the parser argument --force to enable regenerating of processed files during testing.

Checklist

  • I have read and understood the Developer Certificate of Origin (DCO), below, which covers the contents of this pull request (PR).
  • My pull request doesn't include code or content generated with AI.
  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the default branch of the repository (main or master).
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated unit tests and/or test scripts for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no
    visible errors.

Developer Certificate of Origin

For the purposes of this DCO, "license" is equivalent to "license or public domain dedication," and "open source license" is equivalent to "open content license or public domain dedication."

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@oree-xx oree-xx requested review from a team as code owners January 7, 2026 04:32
@oree-xx oree-xx requested review from TimidRobot and possumbilities and removed request for a team January 7, 2026 04:32
@cc-open-source-bot cc-open-source-bot moved this to In review in TimidRobot Jan 7, 2026
Copy link
Member

@TimidRobot TimidRobot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you can leave the files with their original name, except notes.py which can be renamed zzz-notes.py to ensure it is last.

@oree-xx
Copy link
Contributor Author

oree-xx commented Jan 8, 2026

@TimidRobot I worked on the updatereadme function, it inserts the sections in an order. I just have a little issue with what I pushed to this PR. I am trying to resolve that.

Copy link
Member

@TimidRobot TimidRobot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good work here! Please also update the PR description and title to better represent all of the work now included.

@oree-xx oree-xx changed the title Prefix for section order Improve report sections and avoid regenerating existing files Jan 9, 2026
@TimidRobot TimidRobot self-assigned this Jan 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: In review

Development

Successfully merging this pull request may close these issues.

2 participants