refine(CLI plan issue): add .corpora global context to plan issue response

skyl commented 1 week ago

PR Type

enhancement, documentation

Description

Enhanced the get_relevant_splits_context method to improve the formatting of split context output.
Refined the system message for issue creation to be more concise and added a function to gather additional context.
Integrated additional context files into the issue creation process in the CLI.
Extended the IssueRequestSchema with new optional fields: voice, purpose, structure, and directions.
Updated tests to include new optional fields in IssueRequestSchema.
Documented the new optional fields in IssueRequestSchema.

Changes walkthrough 📝

Relevant files

Enhancement

models.py `Enhance split context formatting for clarity` py/packages/corpora/models.py - Improved formatting of split context output.	+1/-1
plan.py `Refine issue creation with additional context and message handling` py/packages/corpora/routers/plan.py Refined the system message for issue creation. Added function to gather additional context for issues. Updated message handling to include additional context.	+50/-12
plan.py `Integrate additional context files into issue creation` py/packages/corpora_cli/commands/plan.py Added reading of additional context files for issue creation. Updated issue request schema to include new context fields.	+22/-5
issue_request_schema.py `Extend IssueRequestSchema with additional optional fields` py/packages/corpora_client/models/issue_request_schema.py Added optional fields for voice, purpose, structure, and directions. Updated from_dict method to handle new fields.	+21/-2

Tests

test_issue_request_schema.py

Update tests for IssueRequestSchema with new fields

py/packages/corpora_client/test/test_issue_request_schema.py - Updated test instance creation to include new optional fields.

+5/-1

Documentation

IssueRequestSchema.md

Document new fields in IssueRequestSchema

py/packages/corpora_client/docs/IssueRequestSchema.md - Documented new optional fields in IssueRequestSchema.

+4/-0

💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

github-actions[bot] commented 1 week ago

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 3 🔵🔵🔵⚪⚪

🧪 PR contains tests

🔒 No security concerns identified

⚡ Recommended focus areas for review

Code Smell
The `get_relevant_splits_context` method appends strings in a loop, which can be inefficient for large data sets. Consider using a list to collect strings and join them at the end for better performance. Code Smell
The `get_additional_context` function uses multiple `if` statements to append context. Consider refactoring to make it more concise and maintainable, possibly by using a dictionary or a loop.

github-actions[bot] commented 1 week ago

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Score
Performance	Use a more efficient method to construct the `split_context` string ___ Consider using a list comprehension or the `join` method to construct `split_context` more efficiently, which can improve performance and readability. [py/packages/corpora/models.py [77-78]](https://github.com/skyl/corpora/pull/35/files#diff-c9de5374aa987d761f770eb99739e686761246600fc6cc0155902d79c9aa3ea5R77-R78) ```diff -for split in splits: - split_context += f"\n\n{split.file.path}:\n```\n{split.content}\n```\n\n" +split_context = "\n\n".join(f"{split.file.path}:\n```\n{split.content}\n```\n" for split in splits) ``` Suggestion importance[1-10]: 7 Why: The suggestion improves performance and readability by using a more efficient method to construct the `split_context` string. This change is beneficial as it reduces the time complexity of string concatenation in a loop.	7
Possible bug	Safeguard against `None` values in the `get_additional_context` function ___ Ensure that the `get_additional_context` function handles cases where `payload` attributes might be `None` to prevent potential errors. [py/packages/corpora/routers/plan.py [48-54]](https://github.com/skyl/corpora/pull/35/files#diff-d17ee5521ab86acd2823afbc993ced9ea8afb2f074db451ff29c56b83f4e33aaR48-R54) ```diff if any( [ - payload.voice, - payload.purpose, - payload.structure, - payload.directions, + payload.voice or "", + payload.purpose or "", + payload.structure or "", + payload.directions or "", ] ): ``` Suggestion importance[1-10]: 6 Why: The suggestion adds a safeguard against `None` values, which could prevent potential runtime errors. This is a useful enhancement to ensure robustness, although the current implementation may already handle `None` values implicitly.	6
Enhancement	Use dictionary comprehension to simplify the `from_dict` method ___ Consider using a dictionary comprehension to streamline the creation of `_obj` in the `from_dict` method, which can enhance readability. [py/packages/corpora_client/models/issue_request_schema.py [104-118]](https://github.com/skyl/corpora/pull/35/files#diff-0342eddc2dabc255a3d1a7aab790985994ba943ecc167b5446a053caeb7773f7R104-R118) ```diff _obj = cls( - { - "corpus_id": obj.get("corpus_id"), - "messages": ( - [MessageSchema.from_dict(_item) for _item in obj["messages"]] - if obj.get("messages") is not None - else None - ), - "voice": obj.get("voice") if obj.get("voice") is not None else "", - "purpose": obj.get("purpose") if obj.get("purpose") is not None else "", - "structure": ( - obj.get("structure") if obj.get("structure") is not None else "" - ), - "directions": ( - obj.get("directions") if obj.get("directions") is not None else "" - ), - } + {key: obj.get(key, "") for key in ["corpus_id", "voice", "purpose", "structure", "directions"]}, + messages=( + [MessageSchema.from_dict(_item) for _item in obj["messages"]] + if obj.get("messages") is not None + else None + ), ) ``` Suggestion importance[1-10]: 5 Why: The suggestion enhances readability by using a dictionary comprehension, which simplifies the code. However, the improvement is mostly stylistic and does not significantly impact functionality or performance.	5

skyl commented 1 week ago

/describe

github-actions[bot] commented 1 week ago

PR Description updated to latest commit (https://github.com/skyl/corpora/commit/33fffad48f01389432ee525f31f84cfda627a483)

skyl / corpora