Add branch and PR guidelines (#2589)

This commit is contained in:
Paweł Kuna
2026-01-11 17:24:10 +01:00
committed by GitHub
parent 684f40e7c1
commit eac69eb35b
2 changed files with 41 additions and 1 deletions

View File

@@ -0,0 +1,39 @@
---
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
- <13 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.

View File

@@ -30,7 +30,8 @@ Follow these steps to set up Tabler for development:
3. Create a new branch for your changes:
```bash
git checkout -b your-branch-name
# Use the project branch naming convention, e.g.:
git checkout -b fix/markdown-table-overflow
```
## Development