Skip to content

Conversation

@jgbradley1
Copy link
Collaborator

@jgbradley1 jgbradley1 commented Dec 8, 2024

Description

This PR consist of multiple cleanup changes, mostly focused on the factory methods/classes across the codebase.

  • refactor all factory classes to have a similar design pattern
  • rename more reporter terminology to “logger” across the codebase for better clarity and alignment with standard best practices
  • add documentation of the high-level repo structure to the developer guide to help contributors understand the codebase better and get started faster
  • ensure all factories have a registration function to allow external users to provide custom implementations to the library

Checklist

  • I have tested these changes locally.
  • I have reviewed the code changes.
  • I have updated the documentation (if necessary).
  • I have added appropriate unit tests (if applicable).

Notes

I will create a separate PR later that truly updates/refactors all the reporter terminology as it is more invasive and touches more files. This is with the eventual goal in mind to merge the ProgressLogger/ProgressReporter classes together with the PipelineReporter classes so that we have a single source for logging in the codebase instead of two.

@jgbradley1 jgbradley1 requested review from a team as code owners December 8, 2024 21:10
@AlonsoGuevara AlonsoGuevara merged commit 8233421 into main Dec 10, 2024
15 checks passed
@AlonsoGuevara AlonsoGuevara deleted the joshbradley/factory-cleanup branch December 10, 2024 22:11
opensourcemukul pushed a commit to opensourcemukul/graphrag that referenced this pull request Sep 13, 2025
* cleanup factory methods to have similar design pattern across codebase

* add semversioner file

* cleanup logging factory

* update developer guide

* add comment

* typo fix

* cleanup reporter terminology

* renmae reporter to logger

* fix comments

* update comment

* instantiate factory classes correctly and update index api callback parameter

---------

Co-authored-by: Alonso Guevara <alonsog@microsoft.com>
Brandsma pushed a commit to ThalamusLabs/MMGraphRAG that referenced this pull request Nov 6, 2025
* cleanup factory methods to have similar design pattern across codebase

* add semversioner file

* cleanup logging factory

* update developer guide

* add comment

* typo fix

* cleanup reporter terminology

* renmae reporter to logger

* fix comments

* update comment

* instantiate factory classes correctly and update index api callback parameter

---------

Co-authored-by: Alonso Guevara <alonsog@microsoft.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants