Skip to content

Add a PR template - #21321

Closed
chrisbra wants to merge 5 commits into
vim:masterfrom
chrisbra:pull-template
Closed

chrisbra wants to merge 5 commits into
vim:masterfrom
chrisbra:pull-template

Conversation

@chrisbra

Copy link
Copy Markdown
Member

No description provided.

@chrisbra

Copy link
Copy Markdown
Member Author

related: #21318

Comment thread .github/pull_request_template.md Outdated
Comment thread .github/pull_request_template.md Outdated
Comment thread .github/pull_request_template.md Outdated
Comment thread .github/pull_request_template.md Outdated
- If AI helped you write or investigate the change or test, add a line
"Supported by AI" to the commit message.
- If AI wrote the commit itself, add the trailer
"Co-authored-by: AI" instead.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've used "Co-authored-by: Claude ..." in several commits where I'd authored much of the code myself. A co-author is normally understood to be someone - here, something - that wrote part of something.

A line in the commit message body could record when all code changes came from a tool.

Comment on lines +8 to +13
### What does this change do?

<!--
One or two sentences, please clearly write what problem this PR fixes,
for visual changes, a before/after screenshot is helpful
-->

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't this be in the commit message?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes of course, that's what the Problem/Solution lines is for. But sometimes when reviewing a PR, this makes it clear about the difference.

Comment thread .github/pull_request_template.md Outdated
Comment thread .github/pull_request_template.md Outdated
Comment thread .github/pull_request_template.md Outdated
Comment thread .github/pull_request_template.md Outdated
Signed-off-by: Christian Brabandt <[email protected]>
Signed-off-by: Christian Brabandt <[email protected]>
Comment thread .github/pull_request_template.md Outdated
Comment thread .github/pull_request_template.md Outdated
Comment thread .github/pull_request_template.md Outdated
Comment thread .github/pull_request_template.md Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants