Repository navigation
docs: add conventional PR title guidance with Linear references - #88
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Add a PR template with Conventional Commit title guidance, ported from rootlyhq/terraform-provider-rootly#571 and adapted for the Java client. Include feature, fix, documentation, dependency, and breaking-change examples, plus instructions to preserve the format when squash-merging and keep Linear references as title suffixes.
Motivation
Release Please uses commit messages for release notes and version bumps. Ticket-prefixed titles can omit changes from generated release notes; this guidance keeps titles parseable while retaining useful issue context.
Testing
git diff --cached --checkpassed before committing.Risk Assessment
Low risk: adds contributor guidance only.