feat: rename style_guide_path to additional_instructions_path#5
Merged
Conversation
The input was always "a file the LLM should attend to alongside the diff", but its name and prompt template hard-wired it to style-violation framing. Generalizing the surface unlocks deployment-supplied progress trackers, framework cross-checks, doc/wiki references, etc., reusing the same single-agent slot. Changes: - action.yml: rename input. INPUT_STYLE_GUIDE_PATH env var renamed to INPUT_ADDITIONAL_INSTRUCTIONS_PATH. - summary.py: rename internals (style_guide_* → instructions_*, check_style_adherence → apply_additional_instructions). Generalize the comment section label from "🎨 Style Guide Adherence" to "📋 Additional Analysis". - prompts/check_style.md → prompts/additional_instructions.md with generalized framing. The new template tells the LLM the deployment- supplied content may ask for style violations, progress assessment, doc cross-checks, or anything else; output shape is dictated by the instructions themselves, not by the template. - .github/workflows/ci.yml: update prompt-template existence checks. - tests: rename test_check_style_adherence_returns_none_without_style_guide. - README: update docs and the prompt-template inventory. Style-guide use is unaffected for consumers who pass CONTRIBUTING.md (or any prose style guide): the file content is now interpreted by a more permissive prompt, but a clearly-framed style guide still yields a violation listing. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Three pre-existing issues surfaced by CI on the rename PR; none are caused by the rename but they block the lint step. - summary.py:125 (E701): split `if not file_diff.strip(): continue` onto two lines. - summary.py:823 (F541): drop the leading `f` from an f-string that has no placeholders. - action.yml: declare `MERGE_BASE` in the summary.py step's env block. The variable is already exported by the preceding `Generate diff` step via `GITHUB_ENV`, so this is a runtime no-op; the explicit declaration is required by the CI env-var consistency check, which only inspects the step-local env map. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The input was always "a file the LLM should attend to alongside the diff", but its name and prompt template hard-wired it to style-violation framing. Generalizing the surface unlocks deployment-supplied progress trackers, framework cross-checks, doc/wiki references, etc., reusing the same single-agent slot.
Changes:
Style-guide use is unaffected for consumers who pass CONTRIBUTING.md (or any prose style guide): the file content is now interpreted by a more permissive prompt, but a clearly-framed style guide still yields a violation listing.