morningman opened a new pull request, #17: URL: https://github.com/apache/doris-skills/pull/17
## Why A Problem Summary that describes the problem only in words leaves reviewers who don't know the module to rebuild the case in their heads before they get the point. One small, real example does that for them: the statement, and what it gives before and after the change. In apache/doris#70366, for instance, "a credential after or inside supplementary characters stays partly or fully in clear text" lands much faster next to a `CREATE CATALOG` statement whose audit-log text keeps `"secret"` right after `*XXX`. ## What changes - `references/write.md`: Problem Summary ends with one simple, concrete example whenever the problem fits in a few lines: the smallest case, with what it gives before and after the change. For a bug, that is the triggering statement and its wrong result, error, or log line; for a new or changed behavior, the statement or setting as users write it; for a slowdown, the query and its time. SQL goes in a fenced block and a before-and-after comparison in a table. Every output is copied from a run, cutting only what both sides share. An example that needs more than a few lines goes in the issue, with a pointer from Problem Summary; when nothing can be shown, as in most refactors, there is none. - `references/issue.md`: an issue's Current behavior shows the same kind of example, and Expected behavior is stated on it. - `references/development.md`: development records the example and its outputs in the handoff draft, while the code without the change is still at hand. `develop-with-evidence` reads only this file and the type file, so the rule is stated here as well. - `references/types/bugfix.md`: Problem Summary ends with the shortest reproduction, and Frequency may refer to it instead of repeating it. `references/types/enhancement.md`: Before and after doesn't repeat an example that Problem Summary already shows. - `references/examples/bugfix.md`: the worked example now has one. - `scripts/check_pr.py`: a table in Problem Summary no longer counts toward its 150-word warning, as code blocks already didn't. Without this, the example in apache/doris#70366 set off `Problem Summary: 166 words`. ## Notes for reviewers - The other worked examples are unchanged. A Feature's Usage field already holds a complete example, and Refactor, Revert, and Release/Dependency PRs often have nothing to show, which the rule allows. ## Testing - `python3 skills/doris-pr-description/scripts/check_pr.py --self-test` → `Self-test: 11 examples in 10 files, 0 problems`. - The checker before and after this change, on the description of apache/doris#70366 with its new example (`--diff` over that PR's commit): before, `Problem Summary: 166 words` plus a 765-word prose warning for the whole description; after, only the prose warning, which the description already had (737 words) without the example. 🤖 Generated with [Claude Code](https://claude.com/claude-code) -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
