Create Pull Request

Guide for creating well-structured Pull Requests.

Before You Start

Template-based npm packages and VS Code extensions run CI style-check (eslint / prettier / markdownlint).

Before commit and before push/PR, prefer:

npm run style-fix

That typically runs lint:fix + format + lint:md:fix (exact composition may vary by package scripts).

Do not rely on npm run format alone — markdownlint/eslint failures still burn a CI run.

If style-fix is missing, run the package’s fix scripts that match CI style-check, then re-run npm run style-check locally when available.

Use the same format as commit messages:

<type>(<scope>): <description>

Examples:

feat(parser): add support for nested configs
fix(ui): resolve panel flickering on resize
docs: update installation guide

Your branch	PR target	Merge strategy
`feature/*`	`develop`	Squash
`bugfix/*`	`develop`	Squash
`fork:develop` / `fork:feature/` / `fork:bugfix/`	`develop`	Squash
`release/v*`	`main`	Merge commit (created by action)
`hotfix/v*`	`main`	Merge commit (created by action)
Upmerge	`develop`	Merge commit (created by action)

Each repository has two PR templates — GitHub will prompt you to choose:

.github/PULL_REQUEST_TEMPLATE/feature-bugfix.md — for feature and bugfix PRs
.github/PULL_REQUEST_TEMPLATE/release.md — for release and hotfix PRs (auto-selected by the action)

Fill out the chosen template completely before requesting review.

Correct target branch
npm run style-fix (or equivalent) run; local style-check clean when available
CI checks pass
No merge conflicts
PR description filled out
Linked to issue

Address all review comments before merge
Do not merge your own PR (unless explicitly allowed)
Maintainer merges with correct strategy (squash or merge commit per table above)