Skip to content

Commit a482849

Browse files
committed
chore(ship): note what to keep out of PR titles and descriptions
1 parent 292a7ce commit a482849

3 files changed

Lines changed: 30 additions & 0 deletions

File tree

.agents/skills/ship/SKILL.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,16 @@ improvement(scope): description for enhancements
100100
chore(scope): description for maintenance
101101
```
102102

103+
## What to Omit
104+
105+
The repo is public. Keep the title and description to the code change and its reasoning — never:
106+
107+
- Customer, company, or user names; workspace/user/org IDs; email addresses
108+
- Prod or staging operational data: log lines, DB rows, metrics, timestamps, incident details, canary/alert output
109+
- Infrastructure specifics: hostnames, ARNs, internal URLs, env var values, secret names
110+
111+
Describe the bug by its mechanism, not by how you found it. "Expired OAuth credentials fail to refresh in the worker" — not "the Sheets canary failed at 16:31Z for workspace abc-123".
112+
103113
## PR Description Format
104114

105115
Use this exact template in the user's voice (concise, bullet points):

.claude/commands/ship.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,16 @@ improvement(scope): description for enhancements
9999
chore(scope): description for maintenance
100100
```
101101

102+
## What to Omit
103+
104+
The repo is public. Keep the title and description to the code change and its reasoning — never:
105+
106+
- Customer, company, or user names; workspace/user/org IDs; email addresses
107+
- Prod or staging operational data: log lines, DB rows, metrics, timestamps, incident details, canary/alert output
108+
- Infrastructure specifics: hostnames, ARNs, internal URLs, env var values, secret names
109+
110+
Describe the bug by its mechanism, not by how you found it. "Expired OAuth credentials fail to refresh in the worker" — not "the Sheets canary failed at 16:31Z for workspace abc-123".
111+
102112
## PR Description Format
103113

104114
Use this exact template in the user's voice (concise, bullet points):

.cursor/commands/ship.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,16 @@ improvement(scope): description for enhancements
9494
chore(scope): description for maintenance
9595
```
9696

97+
## What to Omit
98+
99+
The repo is public. Keep the title and description to the code change and its reasoning — never:
100+
101+
- Customer, company, or user names; workspace/user/org IDs; email addresses
102+
- Prod or staging operational data: log lines, DB rows, metrics, timestamps, incident details, canary/alert output
103+
- Infrastructure specifics: hostnames, ARNs, internal URLs, env var values, secret names
104+
105+
Describe the bug by its mechanism, not by how you found it. "Expired OAuth credentials fail to refresh in the worker" — not "the Sheets canary failed at 16:31Z for workspace abc-123".
106+
97107
## PR Description Format
98108

99109
Use this exact template in the user's voice (concise, bullet points):

0 commit comments

Comments
 (0)