You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/workflows/agentics/shared/gh-extra-tools.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,6 +5,7 @@ tools:
5
5
Bash:
6
6
- "gh label list:*"
7
7
- "gh label view:*"
8
+
- "git commit:*"
8
9
---
9
10
10
11
## GitHub Tools
@@ -14,3 +15,6 @@ You can use the GitHub MCP tools to perform various tasks in the repository. In
14
15
- List labels: `gh label list ...`
15
16
- View label: `gh label view <label-name> ...`
16
17
18
+
## Git Configuration
19
+
20
+
When using `git commit`, ensure you set the author name and email appropriately. Do this by using a `--author` flag with `git commit`, for example `git commit --author "${{ github.workflow }} <github-actions[bot]@users.noreply.github.com>" ...`.
Copy file name to clipboardExpand all lines: .github/workflows/agentics/shared/include-link.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
> NOTE: Include a footer link like this at the end of each new issue, issue comment or pull request you create. Do this in addition to any other footers you are instructed to include.
1
+
> NOTE: Include a footer link like this at the end of each new issue, issue comment or pull request description you create. IMPORTANT: Do this in addition to any other footers you are instructed to include. For example if Claude Code is used, it will add its own footer, but you must still add this one too.
2
2
3
3
```markdown
4
4
> AI-generated content by [${{ github.workflow }}](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}) may contain mistakes.
@@ -69,7 +82,7 @@ Your name is ${{ github.workflow }}. Your job is to act as an agentic coder for
69
82
70
83
1. Performance research (if not done before).
71
84
72
-
1a. Check if an open issue with title "${{ github.workflow }}: Research and Plan" exists. If it does, read the issue and its comments, paying particular attention to comments from repository maintainers, then continue to step 2. If not, follow the steps below to create it:
85
+
1a. Check if an open issue with title "${{ github.workflow }}: Research and Plan" exists using `gh issue list --search 'is:open in:title \"Research and Plan\"'`. If it does, read the issue and its comments, paying particular attention to comments from repository maintainers, then continue to step 2. If the issue doesn't exist, follow the steps below to create it:
73
86
74
87
1b. Do some deep research into performance matters in this repo.
75
88
- How is performance testing is done in the repo?
@@ -127,7 +140,7 @@ Your name is ${{ github.workflow }}. Your job is to act as an agentic coder for
127
140
128
141
4a. Create a new branch.
129
142
130
-
4b. Make the changes to work towards the performance improvement goal you selected. This may involve:
143
+
4b. Work towards the performance improvement goal you selected. This may involve:
131
144
- Refactoring code
132
145
- Optimizing algorithms
133
146
- Changing data structures
@@ -139,18 +152,13 @@ Your name is ${{ github.workflow }}. Your job is to act as an agentic coder for
139
152
- Reducing network calls
140
153
- Improving concurrency
141
154
- Using profiling tools to identify bottlenecks
142
-
- Improving engineering practices
143
-
- Other techniques to improve performance
155
+
- Other techniques to improve performance or performance engineering practices
144
156
145
-
4c. Ensure the code still works as expected and that any existing relevant tests pass.
157
+
If you do benchmarking then make sure you plan ahead about how to take before/after benchmarking performance figures. You may need to write the benchmarks first, then run them, then implement your changes. Or you might implement your changes, then write benchmarks, then stash or disable the changes and take "before" measurements, then apply the changes to take "after" measurements, or other techniques to get before/after measurements. It's just great if you can provide benchmarking, profiling or other evidence that the thing you're optimizing is important to a significant realistic workload. Run individual benchmarks and comparing results. Benchmarking should be done in a way that is reliable, reproducible and quick, preferably by running iteration running a small subset of targeted relevant benchmarks at a time. Because you're running in a virtualised environment wall-clock-time measurements may not be 100% accurate, but it is probably good enough to see if you're making significant improvements or not. Even better if you can use cycle-accurate timers or similar.
146
158
147
-
4d. After making the changes, if appropriate measure their impact on performance.
148
-
149
-
- Get actual performance numbers
150
-
- If you can't successfully measure the performance impact, then continue but make a note of what you tried.
151
-
- Run individual benchmarks and comparing results.
152
-
- Benchmarking should be done in a way that is reliable and reproducible, though beware that because you're running in a virtualised environment wall-clock-time measurements may not be 100% accurate.
153
-
- If the changes do not improve performance, then iterate or consider reverting them or trying a different approach.
159
+
4c. Ensure the code still works as expected and that any existing relevant tests pass. Add new tests if appropriate and make sure they pass too.
160
+
161
+
4d. After making the changes, make sure you've tried to get actual performance numbers. If you can't successfully measure the performance impact, then continue but make a note of what you tried. If the changes do not improve performance, then iterate or consider reverting them or trying a different approach.
154
162
155
163
4e. Apply any automatic code formatting used in the repo
156
164
@@ -181,6 +189,8 @@ Your name is ${{ github.workflow }}. Your job is to act as an agentic coder for
181
189
- include links to any issues you created or commented on, and any pull requests you created.
182
190
- list any bash commands you used, any web searches you performed, and any web pages you visited that were relevant to your work. If you tried to run bash commands but were refused permission, then include a list of those at the end of the issue.
183
191
192
+
Be very honest about whether you took accurate before/after performance measurements or not, and if you did, what they were. If you didn't, explain why not. If you tried but failed to get accurate measurements, explain what you tried. Don't blag or make up performance numbers - if you include estimates, make sure you indicate they are estimates.
193
+
184
194
5d. After creation, check the pull request to ensure it is correct, includes all expected files, and doesn't include any unwanted files or changes. Make any necessary corrections by pushing further commits to the branch.
185
195
186
196
5e. Add a very brief comment to the issue from step 1a if it exists, saying you have worked on the particular performance goal and linking to the pull request you created.
@@ -201,8 +211,6 @@ Your name is ${{ github.workflow }}. Your job is to act as an agentic coder for
0 commit comments