Skip to content

Commit 7f3f76d

Browse files
committed
Improve AI assistance tracking in documentation
1 parent 1c3c601 commit 7f3f76d

File tree

4 files changed

+19
-4
lines changed

4 files changed

+19
-4
lines changed

docs/automations/integrations/copilot/flag-copilot-pr/README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,22 @@ starter_kits: [genai]
99
Automatically apply labels to PRs that are assisted by GitHub Copilot. You can apply labels based on a known list of Copilot users, PR tags, or by prompting the PR author to indicate if they used Copilot.
1010

1111
=== "Label by AI Rules"
12-
Automatically apply labels to PRs based on Copilot AI rules.
12+
Automatically apply labels to PRs based on Copilot AI rules, providing a data-driven approach to track developer adoption of AI tools without requiring manual input from developers.
13+
14+
This solution automatically tracks AI tool usage without requiring developers to fill out surveys or take manual actions. Each AI-assisted edit is logged with unique identifiers in structured JSON format, setting the foundation for analytics across different AI tools while maintaining a consistent data model.
1315

1416
!!! info "Configuration Description"
1517
Conditions:
1618

1719
* A PR is created
1820
* Copilot AI was used in this PR
1921
* Copilot rule file was added to the repo
22+
* Changes to `.cm/ai.log` file are detected (this file contains entries for each AI-assisted action)
2023

2124
Automation Actions:
2225

2326
* PR is labeled with `ai-assisted`
27+
* Structured data about AI usage is logged for future analytics
2428

2529
!!! example "`.github/copilot-instructions.md`"
2630
```yaml+jinja
@@ -42,6 +46,9 @@ Automatically apply labels to PRs that are assisted by GitHub Copilot. You can a
4246
</span>
4347
</div>
4448

49+
!!! tip
50+
Add `.cm/ai.log linguist-generated=true` to your `.gitattributes` file to ensure that Copilot-generated files are not included in your repository.
51+
4552
=== "Label by Survey"
4653
Prompt PR authors to indicate if they used Copilot for the PR and automatically label the PR if they did. This requires two separate automation files to handle posting the prompt and labeling accordingly.
4754

docs/automations/integrations/cursor/flag-cursor-pr/README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,22 @@ category: [quality, genai, cursor, quickstart]
99
Automatically apply labels to Pull Requests that are assisted by Cursor AI. This automation helps track the impact and usage of Cursor's AI capabilities across your development workflow.
1010

1111
=== "Label by AI Rules"
12-
Automatically apply labels to PRs based on Cursor AI rules.
12+
Automatically apply labels to PRs based on Cursor AI rules, providing a data-driven approach to track developer adoption of AI tools without requiring manual input from developers.
13+
14+
This solution automatically tracks AI tool usage without requiring developers to fill out surveys or take manual actions. Each AI-assisted edit is logged with unique identifiers in structured JSON format, setting the foundation for analytics across different AI tools while maintaining a consistent data model.
1315

1416
!!! info "Configuration Description"
1517
Conditions:
1618

1719
* A PR is created
1820
* Cursor AI was used in this PR
1921
* Cursor rule file was added to the repo
22+
* Changes to `.cm/ai.log` file are detected (this file contains entries for each AI-assisted action)
2023

2124
Automation Actions:
2225

2326
* PR is labeled with `ai-assisted`
27+
* Structured data about AI usage is logged for future analytics
2428

2529
!!! example "`.cursor/rules/cursor-ai-logging.mdc`"
2630
```yaml+jinja
@@ -42,6 +46,10 @@ Automatically apply labels to Pull Requests that are assisted by Cursor AI. This
4246
</span>
4347
</div>
4448

49+
!!! tip
50+
Add `.cm/ai.log linguist-generated=true` to your `.gitattributes` file to ensure that AI-generated files are marked as generated content.
51+
52+
4553
=== "Label by Survey"
4654
Prompt PR authors to indicate if they used Cursor for the PR and automatically label the PR if they did. This requires two separate automation files to handle posting the prompt and labeling accordingly.
4755

docs/downloads/automation-library/integrations/copilot/label_copilot_by_rule.cm

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ automations:
99
- action: add-labels@v1
1010
args:
1111
labels:
12-
- ai-tool-usage
12+
- ai-assisted

docs/downloads/automation-library/integrations/cursor/label_cursor_by_rule.cm

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ automations:
99
- action: add-labels@v1
1010
args:
1111
labels:
12-
- ai-tool-usage
12+
- ai-assisted

0 commit comments

Comments
 (0)