From 5c10ea5bd6132795342599ceaf8c040a89e190c1 Mon Sep 17 00:00:00 2001 From: Andrey Antukh Date: Mon, 7 Sep 2026 08:41:54 +0000 Subject: [PATCH] :books: Document branch naming convention The creating-prs memory described a branch format (issue/... with a / fallback) that does not match actual repo practice, where issue-driven branches are issue-NNNN. Replace it with a Branch Naming section: issue-NNNN as primary, descriptive name without slashes as fallback. Add the matching public convention to CONTRIBUTING.md under Pull Requests, which previously defined no branch naming at all. AI-assisted-by: omen-alpha --- .serena/memories/workflow/creating-prs.md | 8 +++++++- CONTRIBUTING.md | 13 +++++++++++++ 2 files changed, 20 insertions(+), 1 deletion(-) diff --git a/.serena/memories/workflow/creating-prs.md b/.serena/memories/workflow/creating-prs.md index a92c199e22..fa94a9afe0 100644 --- a/.serena/memories/workflow/creating-prs.md +++ b/.serena/memories/workflow/creating-prs.md @@ -1,6 +1,12 @@ # Creating Pull Requests -PR only on explicit request. Branch: issue/feature-specific; fallback `/` (`fix/...`, `feat/...`, `refactor/...`, `docs/...`, `chore/...`, `perf/...`). +PR only on explicit request. + +## Branch Naming + +- Primary: `issue-NNNN` — one branch per GitHub issue (e.g. `issue-11525`). +- No issue: free-form descriptive name, dash-separated, no slashes (e.g. `fix-ellipse-icon-typo`, `feat-auto-link-libraries`). +- If the user already created the branch, use it as-is — never rename. ## Target Branch diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 63b931900f..d905aae9e0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,6 +14,7 @@ Center](https://help.penpot.app/). - [Reporting Bugs](#reporting-bugs) - [Pull Requests](#pull-requests) - [Workflow](#workflow) + - [Branch naming](#branch-naming) - [Format](#format) - [Title format](#title-format) - [Description](#description) @@ -73,6 +74,18 @@ Advisories](https://github.com/penpot/penpot/security/advisories) 4. **Format and lint** — run the checks described in [Formatting and Linting](#formatting-and-linting) before submitting. +### Branch naming + +Branch names are not enforced, but we recommend the following: + +- **`issue-NNNN`** — when working from a GitHub issue, name the branch after + it (e.g. `issue-11525`). This makes each PR's origin self-evident. +- Otherwise, use a short, descriptive name with words separated by hyphens + and no slashes (e.g. `fix-ellipse-icon-typo`, `feat-auto-link-libraries`). + +Since PRs are squash-merged, the branch name does not survive into the +commit history — what matters is the [PR title](#title-format). + ### Format #### Title