Skip to content

Commit 8cb231b

Browse files
authored
docs: add AI compliance workflow to copilot instructions (#1899)
Added comprehensive AI-Assisted Development & Compliance section including: - PR labeling requirements - Mandatory Jira field updates - Documentation standards - Workflow integration - Audit trail requirements Signed-off-by: Rishi Kumar Chawda <[email protected]>
1 parent 5b2f9d1 commit 8cb231b

File tree

1 file changed

+48
-0
lines changed

1 file changed

+48
-0
lines changed

.github/copilot-instructions.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -255,4 +255,52 @@ When working with Jira issues:
255255
- Reference related issues and PRs appropriately
256256
- Maintain professional tone in all communications
257257
258+
## AI-Assisted Development & Compliance
259+
260+
- ✅ Create PR with `ai-assisted` label (if label doesn't exist, create it with description "Work completed with AI assistance following Progress AI policies" and color "9A4DFF")
261+
- ✅ Include "This work was completed with AI assistance following Progress AI policies" in PR description
262+
263+
### Jira Ticket Updates (MANDATORY)
264+
265+
- ✅ **IMMEDIATELY after PR creation**: Update Jira ticket custom field `customfield_11170` ("Does this Work Include AI Assisted Code?") to "Yes"
266+
- ✅ Use atlassian-mcp tools to update the Jira field programmatically
267+
- ✅ **CRITICAL**: Use correct field format: `{"customfield_11170": {"value": "Yes"}}`
268+
- ✅ Verify the field update was successful
269+
270+
### Documentation Requirements
271+
272+
- ✅ Reference AI assistance in commit messages where appropriate
273+
- ✅ Document any AI-generated code patterns or approaches in PR description
274+
- ✅ Maintain transparency about which parts were AI-assisted vs manual implementation
275+
276+
### Workflow Integration
277+
278+
This AI compliance checklist should be integrated into the main development workflow Step 4 (Pull Request Creation):
279+
280+
```
281+
Step 4: Pull Request Creation & AI Compliance
282+
- Step 4.1: Create branch and commit changes WITH SIGNED-OFF COMMITS
283+
- Step 4.2: Push changes to remote
284+
- Step 4.3: Create PR with ai-assisted label
285+
- Step 4.4: IMMEDIATELY update Jira customfield_11170 to "Yes"
286+
- Step 4.5: Verify both PR labels and Jira field are properly set
287+
- Step 4.6: Provide complete summary including AI compliance confirmation
288+
```
289+
290+
- **Never skip Jira field updates** - This is required for Progress AI governance
291+
- **Always verify updates succeeded** - Check response from atlassian-mcp tools
292+
- **Treat as atomic operation** - PR creation and Jira updates should happen together
293+
- **Double-check before final summary** - Confirm all AI compliance items are completed
294+
295+
### Audit Trail
296+
297+
All AI-assisted work must be traceable through:
298+
299+
1. GitHub PR labels (`ai-assisted`)
300+
2. Jira custom field (`customfield_11170` = "Yes")
301+
3. PR descriptions mentioning AI assistance
302+
4. Commit messages where relevant
303+
304+
---
305+
258306
This comprehensive guide ensures consistent, high-quality contributions to the Ohai project while following all repository conventions and requirements.

0 commit comments

Comments
 (0)