diff --git a/.cursor/rules/pull-request.mdc b/.cursor/rules/pull-request.mdc new file mode 100644 index 000000000..4a497339c --- /dev/null +++ b/.cursor/rules/pull-request.mdc @@ -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 +- <1–3 bullets describing the change and why> + +## Changes +- +``` + +### 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. diff --git a/docs/content/ui/getting-started/how-to-contribute.md b/docs/content/ui/getting-started/how-to-contribute.md index 601af80e6..7c7917be6 100644 --- a/docs/content/ui/getting-started/how-to-contribute.md +++ b/docs/content/ui/getting-started/how-to-contribute.md @@ -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