Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat/setup talk2scholars - Rename Talk2Competitors to Talk2Scholars Across Codebase, Documentation, and CI/CD Workflows #95

Merged

Conversation

ansh-info
Copy link
Contributor

@ansh-info ansh-info commented Feb 7, 2025

For authors

Description

This PR renames the hierarchical agent from Talk2Competitors to Talk2Scholars across the codebase and documentation to maintain consistency.

Modifications & Updates:

  1. Code Updates:

    • Renamed the main agent and sub-agent from Talk2CompetitorsTalk2Scholars.
    • Updated the Agent State references.
  2. Documentation Updates:

    • Jupyter Notebook tutorial reflects the new name.
    • MkDocs documentation updated accordingly.
  3. CI/CD & Testing:

    • Updated GitHub Actions workflows to reference the new agent name.
    • Verified code coverage and PyLint tests to ensure no naming inconsistencies remain.

Fixes # (issue) Mention the issue number.

Issue #94
Issue #80

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests you conducted to verify your changes. These may involve creating new test scripts or updating existing ones.

  • Added new test(s) in the tests folder
  • Added new function(s) to an existing test(s) (e.g.: tests/testX.py)
  • No new tests added (Please explain the rationale in this case)

Checklist

  • My code follows the style guidelines mentioned in the Code/DevOps guides
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation (e.g. MkDocs)
  • My changes generate no new warnings
  • I have added or updated tests (in the tests folder) that prove my fix is effective or that my feature works
  • New and existing tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

For reviewers

Checklist pre-approval

  • Is there enough documentation?
  • If a new feature has been added, or a bug fixed, has a test been added to confirm good behavior?
  • Does the test(s) successfully test edge/corner cases?
  • Does the PR pass the tests? (if the repository has continuous integration)

Checklist post-approval

  • Does this PR merge develop into main? If so, please make sure to add a prefix (feat/fix/chore) and/or a suffix BREAKING CHANGE (if it's a major release) to your commit message.
  • Does this PR close an issue? If so, please make sure to descriptively close this issue when the PR is merged.

Checklist post-merge

  • When you approve of the PR, merge and close it (Read this article to know about different merge methods on GitHub)
  • Did this PR merge develop into main and is it suppose to run an automated release workflow (if applicable)? If so, please make sure to check under the "Actions" tab to see if the workflow has been initiated, and return later to verify that it has completed successfully.

Copy link
Member

@dmccloskey dmccloskey left a comment

Choose a reason for hiding this comment

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

T2S is good to go 👍

@dmccloskey dmccloskey merged commit d0e742f into VirtualPatientEngine:main Feb 8, 2025
3 of 6 checks passed
Copy link
Contributor

github-actions bot commented Feb 8, 2025

🎉 This PR is included in version 1.16.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

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.

2 participants