adam/open-swe
1
0
Fork 0
mirror of https://github.com/Sea-Haven-Industries/open-swe.git synced 2026-09-30 06:53:14 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

feat: simplify PR attribution footer to "Made by Open SWE" (#1382)

Browse source 
Replace the double-attribution PR body footer (_Opened collaboratively by
{user} and open-swe._) with a single Cursor-style footer linking to the
project. Since PRs are now opened as the triggering user, the user no longer
needs to be named in the footer. The commit Co-authored-by trailer is kept.

Legacy footers are migrated on PR updates.
This commit is contained in:
Johannes du Plessis 2026-06-02 19:52:27 -07:00 • committed by GitHub
parent 5d033c7548
commit 046388a4e9
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 25 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
agent/prompt.py
View file

@ -6,6 +6,7 @@ from pathlib import Path
from .utils.authorship import (
OPEN_SWE_BOT_EMAIL,
OPEN_SWE_BOT_NAME,
PR_ATTRIBUTION_FOOTER,
CollaboratorIdentity,
)
from .utils.github_comments import UNTRUSTED_GITHUB_COMMENT_OPEN_TAG
@ -374,10 +375,10 @@ This run was triggered by **{display_name}**. You author the work **as them**
Co-authored-by: open-swe[bot] <open-swe@users.noreply.github.com>
```
- **PR body**: append this line to the bottom of the PR description (separated from the body by a blank line) when you open or update the draft PR. Do not duplicate it if it is already present. If the PR body already contains the legacy footer `_Opened collaboratively by {display_name} and open-swe._`, replace that legacy footer with this line instead of appending a second footer:
- **PR body**: append this line to the bottom of the PR description (separated from the body by a blank line) when you open or update the draft PR. Do not duplicate it if it is already present. If the PR body already contains a legacy footer like `_Opened collaboratively by {display_name} and open-swe._`, replace that legacy footer with this line instead of appending a second footer:
```
_Opened collaboratively by {pr_attribution_name} and open-swe._
{pr_attribution_footer}
```
If you forget the trailer on a local commit that has not been pushed, fix it with `git commit --amend` before pushing — do not push without it. If the commit has already been pushed, leave it as-is and add the trailer to your next commit; never rewrite remote history to fix it."""
@ -388,7 +389,7 @@ def _render_collaboration_section(identity: CollaboratorIdentity | None) -> str:
return ""
return COLLABORATION_TEMPLATE.format(
display_name=identity.display_name,
pr_attribution_name=identity.pr_attribution_name,
pr_attribution_footer=PR_ATTRIBUTION_FOOTER,
)

29
agent/utils/authorship.py
View file

@ -13,6 +13,8 @@ logger = logging.getLogger(__name__)
OPEN_SWE_BOT_NAME = "open-swe[bot]"
OPEN_SWE_BOT_EMAIL = "open-swe@users.noreply.github.com"
PR_ATTRIBUTION_FOOTER = "Made by [Open SWE](https://openswe.vercel.app)"
@dataclass(frozen=True)
class CollaboratorIdentity:
@ -153,24 +155,29 @@ def add_bot_coauthor_trailer(commit_message: str) -> str:
def add_pr_collaboration_note(
pr_body: str,
identity: CollaboratorIdentity | None,
identity: CollaboratorIdentity | None = None,
) -> str:
"""Append a best-effort PR attribution note.
"""Append the Open SWE attribution footer to a PR body.
GitHub supports commit co-authors, but not PR co-authors. This note makes
the collaboration explicit in the automatically-opened PR body.
The PR is opened as the triggering user, so the body only credits Open SWE
as the collaborator. Any legacy double-attribution footer is replaced.
"""
normalized_body = pr_body.rstrip()
if not identity:
return normalized_body
old_note = f"_Opened collaboratively by {identity.display_name} and open-swe._"
note = f"_Opened collaboratively by {identity.pr_attribution_name} and open-swe._"
note = PR_ATTRIBUTION_FOOTER
if note in normalized_body:
return normalized_body
if old_note in normalized_body:
return normalized_body.replace(old_note, note)
legacy_footers: list[str] = []
if identity is not None:
legacy_footers.append(
f"_Opened collaboratively by {identity.pr_attribution_name} and open-swe._"
)
legacy_footers.append(f"_Opened collaboratively by {identity.display_name} and open-swe._")
for legacy in legacy_footers:
if legacy in normalized_body:
return normalized_body.replace(legacy, note)
if not normalized_body:
return note
return f"{normalized_body}\n\n{note}"

6
tests/test_github_comment_prompts.py
View file

@ -101,7 +101,7 @@ def test_construct_system_prompt_includes_coauthor_trailer_when_identity_present
assert "git config user.name octocat" in prompt
assert "git config user.email 1234+octocat@users.noreply.github.com" in prompt
assert "Co-authored-by: open-swe[bot] <open-swe@users.noreply.github.com>" in prompt
assert "_Opened collaboratively by octocat and open-swe._" in prompt
assert "Made by [Open SWE](https://openswe.vercel.app)" in prompt
def test_construct_system_prompt_includes_github_login_in_pr_footer() -> None:
@ -121,7 +121,7 @@ def test_construct_system_prompt_includes_github_login_in_pr_footer() -> None:
assert "git config user.name 'Mona Lisa'" in prompt
assert "git config user.email 1234+octocat@users.noreply.github.com" in prompt
assert "Co-authored-by: open-swe[bot] <open-swe@users.noreply.github.com>" in prompt
assert "_Opened collaboratively by Mona Lisa (@octocat) and open-swe._" in prompt
assert "Made by [Open SWE](https://openswe.vercel.app)" in prompt
assert (
"replace that legacy footer with this line instead of appending a second footer" in prompt
)
@ -160,7 +160,7 @@ def test_add_pr_collaboration_note_replaces_legacy_footer() -> None:
body = "## Description\nDone.\n\n_Opened collaboratively by Mona Lisa and open-swe._"
assert add_pr_collaboration_note(body, identity) == (
"## Description\nDone.\n\n_Opened collaboratively by Mona Lisa (@octocat) and open-swe._"
"## Description\nDone.\n\nMade by [Open SWE](https://openswe.vercel.app)"
)