Skip to content

Commit 5d73191

Browse files
authored
docs: permit Jira/EAI ticket IDs in branches, commits, and comments (#110)
* docs: permit Jira/EAI ticket IDs in branches, commits, and comments The team decided bare Jira/EAI-style ticket IDs (e.g. EAI-1234) are fine to use in branch names, commit messages, and code/doc comments. Update the OSS contribution leak-scan guidance to stop flagging them, while still treating links to internal tracking systems as a leak. Signed-off-by: Roman Inflianskas <Roman.Inflianskas@amd.com> * docs: widen ticket-ID permission scope, restore jira leak-scan keyword - match the bare Jira/EAI ticket ID exemption to the same enforcement scope as the rest of the content-restriction rule, instead of a narrower explicit surface list - keep 'jira' in the leak-scan keyword pattern; only ticket-[0-9]+ needed dropping to stop flagging bare ticket IDs like EAI-1234, and jira links to internal tracking hosts should still be caught Signed-off-by: Roman Inflianskas <Roman.Inflianskas@amd.com> --------- Signed-off-by: Roman Inflianskas <Roman.Inflianskas@amd.com>
1 parent 0613cd2 commit 5d73191

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

AGENTS.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,15 +55,16 @@ the full range on push (`verify-commits`), and a blocking CI gate
5555
Content restrictions for upstream surfaces:
5656

5757
- do not include internal/proprietary names, aliases, URLs, hostnames, gateways, cluster names, or registry paths
58-
- do not include internal ticket identifiers, links to internal tracking systems, or unrelated internal usernames
58+
- do not include links to internal tracking systems or unrelated internal usernames
59+
- bare Jira/EAI-style ticket IDs (e.g. `EAI-1234`) are permitted anywhere this rule applies; do not flag them
5960
- apply this rule to PR titles/bodies, issue text, comments, review replies, commit messages, branch names, code comments, fixtures, and logs
6061

6162
Use neutral external framing (for example: "backend" or "gateway") rather than internal or vendor-specific ownership phrasing.
6263

6364
Leak scan before each upstream push/PR/comment batch:
6465

6566
```bash
66-
INTERNAL_KEYWORDS_PATTERN='internal|confidential|proprietary|private|ticket-[0-9]+|jira|confluence|\.corp|\.internal'
67+
INTERNAL_KEYWORDS_PATTERN='internal|confidential|proprietary|private|jira|confluence|\.corp|\.internal'
6768
git diff <upstream-base>..HEAD \
6869
| grep -inE "$INTERNAL_KEYWORDS_PATTERN" \
6970
&& echo "REVIEW each hit" || echo "diff clean"
@@ -104,7 +105,7 @@ grep -rn "^<<<<<<<\|^=======\|^>>>>>>>" .
104105
For leak scans, use upstream base `origin/main` (or upstream default branch if different):
105106

106107
```bash
107-
INTERNAL_KEYWORDS_PATTERN='internal|confidential|proprietary|private|ticket-[0-9]+|jira|confluence|\.corp|\.internal'
108+
INTERNAL_KEYWORDS_PATTERN='internal|confidential|proprietary|private|jira|confluence|\.corp|\.internal'
108109
git diff origin/main..HEAD \
109110
| grep -inE "$INTERNAL_KEYWORDS_PATTERN" \
110111
&& echo "REVIEW each hit" || echo "diff clean"

0 commit comments

Comments
 (0)