Skip to content

docs(llms): add PR template guidelines to LLMS.md - #35148

Merged
eschutho merged 1 commit into
masterfrom
docs/add-pr-template-to-claude-md
Sep 15, 2025
Merged

docs(llms): add PR template guidelines to LLMS.md#35148
eschutho merged 1 commit into
masterfrom
docs/add-pr-template-to-claude-md

Conversation

@eschutho

Copy link
Copy Markdown
Member

SUMMARY

Added comprehensive Pull Request guidelines section to LLMS.md (which CLAUDE.md symlinks to) to help LLM tools create properly formatted PRs that follow Superset conventions.

The new section includes:

  • The complete Superset PR template format with all required sections
  • Conventional Commits specification for PR titles
  • Examples of proper PR title formatting (fix, feat, docs, etc.)

This ensures consistent PR creation when using Claude Code and other LLM tools by providing clear instructions on how to format PR descriptions and titles according to project standards.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

N/A - Documentation only change

TESTING INSTRUCTIONS

  1. Review the added PR guidelines section in LLMS.md
  2. Verify the template matches the actual PR template in .github/PULL_REQUEST_TEMPLATE.md
  3. Confirm the Conventional Commits examples are accurate

ADDITIONAL INFORMATION

  • Has associated issue: N/A
  • Required feature flags: None
  • Changes UI: No
  • Includes DB Migration: No
  • Introduces new feature or API: No
  • Removes existing feature or API: No

🤖 Generated with Claude Code

@dosubot dosubot Bot added the doc Namespace | Anything related to documentation label Sep 15, 2025

@korbit-ai korbit-ai 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.

I've completed my review and didn't find any issues.

Files scanned
File Path Reviewed
superset-frontend/src/dashboard/components/nativeFilters/FilterBar/ActionButtons/index.tsx
superset-frontend/src/dashboard/components/BuilderComponentPane/index.tsx

Explore our documentation to understand the languages and file types we support and the files we ignore.

Check out our docs on how you can make Korbit work best for you and your team.

Loving Korbit!? Share us on LinkedIn Reddit and X

@eschutho
eschutho force-pushed the docs/add-pr-template-to-claude-md branch from 1fafe49 to 131a1e2 Compare September 15, 2025 21:57
@github-actions github-actions Bot removed doc Namespace | Anything related to documentation dependencies:npm labels Sep 15, 2025
Comment thread LLMS.md Outdated
- [ ] Removes existing feature or API
```

**PR Title Convention**: Follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

nit: do we need this or can we point this to the linter and use code as documentation for this? Same as above for the template.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Yeah, that's prob not necessary

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Although I suppose it can help get it right the first time rather than wait for CI.

Added Pull Request guidelines section to LLMS.md that instructs LLM tools to:
- Always read the current PR template from `.github/PULL_REQUEST_TEMPLATE.md`
- Use all required template sections (SUMMARY, TESTING INSTRUCTIONS, etc.)
- Follow Conventional Commits specification for PR titles

This approach ensures LLMs always use the most up-to-date PR template format
rather than relying on potentially outdated cached content.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
@eschutho
eschutho force-pushed the docs/add-pr-template-to-claude-md branch from 131a1e2 to b9c3bf8 Compare September 15, 2025 22:36
@pull-request-size pull-request-size Bot added size/S and removed size/M labels Sep 15, 2025
@eschutho
eschutho merged commit 133e686 into master Sep 15, 2025
63 of 65 checks passed
@eschutho
eschutho deleted the docs/add-pr-template-to-claude-md branch September 15, 2025 22:57
@eschutho eschutho added the 🎪 ⚡ showtime-trigger-start Create new ephemeral environment for this PR label Sep 17, 2025
@sadpandajoe sadpandajoe removed the 🎪 ⚡ showtime-trigger-start Create new ephemeral environment for this PR label Sep 18, 2025
qfcwell pushed a commit to qfcwell/superset that referenced this pull request May 12, 2026
Co-authored-by: Claude <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants