Skip to content

Add TDL-0004: error vs warning semantics and phase boundaries#3004

Draft
ronpal wants to merge 1 commit into
mainfrom
tdl-0004
Draft

Add TDL-0004: error vs warning semantics and phase boundaries#3004
ronpal wants to merge 1 commit into
mainfrom
tdl-0004

Conversation

@ronpal
Copy link
Copy Markdown
Contributor

@ronpal ronpal commented May 15, 2026

Summary

  • Adds TDL-0004 documenting the toolkit's error/warning model: commands run to completion and aggregate issues at the next phase boundary, with ToolkitError reserved for unrecoverable conditions that abort immediately.
  • Acknowledges the three parallel severity systems we have today (legacy tk_warnings.SeverityLevel, build v2 numeric InsightDefinition, dataio/logger.Severity) and the cognite.neat._toolkit_adapter mapping where the Error/Warning naming bug originates.
  • Defines what a phase boundary is per command and why mutation phases stay fail-fast.

Draft for review — the open naming question (WARNING/NOTICE/HINT vs alternatives) is still being settled with @magnus-schjolberg.

Related

  • CDF-27907 — terminology / visual language for build output
  • CDF-27968 — reclassify HIGH-severity warnings as collected errors (uses this TDL as the contract)

Test plan

  • Review wording with @magnus-schjolberg and @anders-albert
  • Confirm naming choice (WARNING/NOTICE/HINT) before implementation work begins on CDF-27968

Document the goal of running commands to completion (collecting issues
at phase boundaries) versus aborting only on ToolkitErrors, which are
by definition unrecoverable. Covers the three coexisting severity
systems (legacy tk_warnings SeverityLevel, build v2 numeric
InsightDefinition, dataio Severity) and the NEAT adapter that
originates the Error/Warning naming mismatch in CDF-27907.

Related: CDF-27907, CDF-27968.
@gemini-code-assist
Copy link
Copy Markdown
Contributor

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 the 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 counterproductive. 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.

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