Pull Request

The Pull Request sub-page lets you customize how StepSecurity formats the pull requests it opens on your behalf. The defaults work out of the box, but you can change them to match your team's commit conventions, PR templates, or contributor guidelines.

What you can customize

The Pull Request sub-page has three fields:

• Title: The text used as the pull request title and the first line of the commit message

• Commit message: The full commit message, including the title line, an optional body, and the Signed-off-by trailer

• Description: The body of the pull request, formatted as Markdown

Description placeholders

The Description field supports placeholders that StepSecurity expands when it opens the pull request. The most important one is:

• {{STEPSECURITY_SECURITY_FIXES}}. Replaced with a list of the specific security fixes included in this pull request. Place it in the section of the description where you want the fixes summarized

The default description also references your StepSecurity username, so reviewers know who to tag with questions about the pull request.

Updating your settings

• Open User Settings and select Pull Request

• Edit the Title, Commit message, or Description as needed

• Click Update PR Settings

To go back to the defaults, click Reset to Default.