mirror of
https://github.com/tabler/tabler.git
synced 2026-01-25 04:16:36 +00:00
40 lines
1.0 KiB
Plaintext
40 lines
1.0 KiB
Plaintext
---
|
||
description: Pull Request Title & Description Rules
|
||
globs:
|
||
alwaysApply: true
|
||
---
|
||
|
||
## Pull request title
|
||
|
||
- Write PR titles in **English**.
|
||
- Start the title with a **capital letter**.
|
||
- Use **present tense** and keep it concise (ideally <= 72 chars).
|
||
- Avoid a trailing period.
|
||
|
||
### Examples
|
||
|
||
- `Improve markdown table overflow handling`
|
||
- `Clarify contributing branch naming`
|
||
- `Add onboarding stepper page`
|
||
|
||
## Pull request description
|
||
|
||
- Write PR descriptions in **English**.
|
||
- Focus on **why** the change is needed and what user-visible effect it has.
|
||
- Keep it skimmable: bullets, short paragraphs, clear headings.
|
||
|
||
### Recommended template
|
||
|
||
```md
|
||
## Summary
|
||
- <1–3 bullets describing the change and why>
|
||
|
||
## Changes
|
||
- <key implementation notes, non-obvious decisions>
|
||
```
|
||
|
||
### Notes
|
||
|
||
- If you changed SCSS or any package behavior, add a **changeset** describing it (one sentence, with backticks for code elements).
|
||
- If a PR is WIP, mark it as draft and prefix the title with `WIP:` only while it is not ready for review.
|