Skip to content

docs: specify empty issue description fallback - #21

Draft
cuhk-shenzhen-dev wants to merge 2 commits into
BetterAndBetterII:mainfrom
cuhk-shenzhen-dev:docs/1040-empty-issue-spec
Draft

docs: specify empty issue description fallback#21
cuhk-shenzhen-dev wants to merge 2 commits into
BetterAndBetterII:mainfrom
cuhk-shenzhen-dev:docs/1040-empty-issue-spec

Conversation

@cuhk-shenzhen-dev

Copy link
Copy Markdown

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

  • Define Issue.description normalization for absent or whitespace-only tracker bodies
  • Specify the default prompt placeholder line for title-only issues
  • Add focused milestones, validation notes, and rollback guidance for this contract

Alternatives

  • Keep the behavior implicit in current Elixir code/tests; rejected because other ports could diverge

Test Plan

  • make -C elixir all (mix is unavailable in this session)
  • git diff --check

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>
@gemini-code-assist

Copy link
Copy Markdown

Summary of Changes

Hello, 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 null and how they are rendered in the default prompt, ensuring consistent behavior across different components and providing a clear fallback for title-only issues.

Highlights

  • Issue Description Normalization: Documented that absent or whitespace-only issue bodies must normalize to null for Issue.description to ensure a single 'missing description' state.
  • Default Prompt Rendering: Specified that the default prompt contract should render a stable placeholder line, 'No description provided.', for issues with missing or blank descriptions instead of an empty body block.
  • Comprehensive Specification: Added a new section detailing the expected behavior, affected boundaries, milestones, test plan, and compatibility/risks/rollback for empty-description tracker issues.

🧠 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
  • SPEC.md
    • Added a rule under Issue.description to normalize absent or whitespace-only issue bodies to null.
    • Included a new rule for prompt rendering inputs, specifying that missing or blank issue.description values should be treated as absent input and render a 'No description provided.' placeholder.
    • Introduced a new section '21. Empty-Description Tracker Issues' which outlines expected behavior, affected boundaries, milestones, test plan, and compatibility/risks/rollback related to handling issues without descriptions.
Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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.

Comment thread SPEC.md Outdated
Comment thread SPEC.md Outdated
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.

1 participant