docs: specify empty issue description fallback - #21
Conversation
Summary: - clarify that tracker issues with empty or blank bodies normalize to `Issue.description = null` - specify the default prompt fallback for title-only issues and add a focused milestone/test-plan section for this behavior Rationale: - issue #1040 is a title-only tracker item, so the spec should state how placeholder issues flow through normalization and prompt rendering - the runtime already handles missing descriptions; this closes the spec gap so future ports implement the same behavior consistently Tests: - `git diff --check` - `make -C elixir all` (fails: `mix` is unavailable in this session) Co-authored-by: Codex <codex@openai.com>
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request enhances the project's specification by formally documenting the contract for handling issues with empty or missing descriptions. It clarifies how such descriptions should be normalized to Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request introduces comprehensive documentation for handling empty or absent issue descriptions. The changes clearly define the contract for normalizing these descriptions to null within tracker adapters and specify the expected rendering behavior in the default prompt. A new, detailed section has been added to the specification covering expected behavior, affected system boundaries, testing, and compatibility considerations. The documentation is thorough and well-structured. I have a couple of minor suggestions to improve consistency in the terminology used.
Note: Security Review has been skipped due to the limited scope of the PR.
Context
Document the empty-description tracker issue contract surfaced by https://github.com/CUHKSZ-ITSO-Dev/ChatGPT-Azure/issues/1040.
TL;DR
Document how blank issue bodies normalize and render in Symphony's default prompt.
Summary
Issue.descriptionnormalization for absent or whitespace-only tracker bodiesAlternatives
Test Plan
make -C elixir all(mixis unavailable in this session)git diff --check