docs: update agent instructions about commit naming in prs#4946
Open
PavelSafronov wants to merge 1 commit into
Open
docs: update agent instructions about commit naming in prs#4946PavelSafronov wants to merge 1 commit into
PavelSafronov wants to merge 1 commit into
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates contributor/agent guidance to avoid unnecessary feedback about commit-message naming inside PR branches by clarifying that this repo uses squash merges and the PR title becomes the final main commit message.
Changes:
- Clarifies that PRs are squash-merged and only the PR title must follow the commit message convention
- Updates wording to specify the PR title Conventional Commits format used for the squash-merge commit
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
Summary of Changes
Update agent instructions for naming convention, specifically the names of PR commits. This update ensures that agents don't complain about naming "issues" in PRs, since we squash commits.
What is the motivation for this change?
Agents complain about things that don't matter: commit messages in PRs.
Double check the following
npm run check:lint)type(NODE-xxxx)[!]: descriptionfeat(NODE-1234)!: rewriting everything in coffeescript