You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@superset.apache.org by el...@apache.org on 2025/09/15 21:50:40 UTC

(superset) 01/01: docs(llms): add PR template guidelines to LLMS.md

This is an automated email from the ASF dual-hosted git repository.

elizabeth pushed a commit to branch docs/add-pr-template-to-claude-md
in repository https://gitbox.apache.org/repos/asf/superset.git

commit 1fafe49c88edd73c2e9beed34ead0d8513d66ccc
Author: Elizabeth Thompson <es...@gmail.com>
AuthorDate: Mon Sep 15 14:49:02 2025 -0700

    docs(llms): add PR template guidelines to LLMS.md
    
    Added comprehensive Pull Request guidelines section to LLMS.md (which CLAUDE.md links to) that includes:
    - The complete Superset PR template format
    - Conventional Commits specification for PR titles
    - Examples of proper PR title formatting
    
    This ensures consistent PR creation when using Claude Code and other LLM tools.
    
    🤖 Generated with [Claude Code](https://claude.ai/code)
    
    Co-Authored-By: Claude <no...@anthropic.com>
---
 LLMS.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)

diff --git a/LLMS.md b/LLMS.md
index ad3fbf2274..c0801091d7 100644
--- a/LLMS.md
+++ b/LLMS.md
@@ -136,6 +136,37 @@ curl -f http://localhost:8088/health || echo "❌ Setup required - see https://s
 - **Use negation operator**: `~Model.field` instead of `== False` to avoid ruff E712 errors
 - **Example**: `~Model.is_active` instead of `Model.is_active == False`
 
+## Pull Request Guidelines
+
+**When creating pull requests, use the Superset PR template format:**
+
+```markdown
+### SUMMARY
+[Describe the change, including rationale and design decisions]
+
+### BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF
+[Skip if not applicable]
+
+### TESTING INSTRUCTIONS
+[Required! What steps can be taken to manually verify the changes?]
+
+### ADDITIONAL INFORMATION
+- [ ] Has associated issue: [Include "Fixes #nnn" if fixing an existing issue]
+- [ ] Required feature flags:
+- [ ] Changes UI
+- [ ] Includes DB Migration (follow approval process in SIP-59)
+  - [ ] Migration is atomic, supports rollback & is backwards-compatible
+  - [ ] Confirm DB migration upgrade and downgrade tested
+  - [ ] Runtime estimates and downtime expectations provided
+- [ ] Introduces new feature or API
+- [ ] Removes existing feature or API
+```
+
+**PR Title Convention**: Follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
+- Format: `type(scope): description`
+- Example: `fix(dashboard): load charts correctly`
+- Types: `fix`, `feat`, `docs`, `style`, `refactor`, `perf`, `test`, `chore`
+
 ## Pre-commit Validation
 
 **Use pre-commit hooks for quality validation:**