Skip to content

Commit 17f47a8

Browse files
laeubimerks
andauthored
Add recommendation about copilote agent (#256)
* Update CONTRIBUTING.md Add recommendation about copilote agent * Apply suggestion from @merks Co-authored-by: Ed Merks <Ed.Merks@gmail.com>
1 parent 613d068 commit 17f47a8

1 file changed

Lines changed: 18 additions & 1 deletion

File tree

CONTRIBUTING.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,23 @@ Fixes https://github.com/eclipse-platform/eclipse.platform.debug/issues/132
177177
Again this is a recommendation on the issue title part. Instead of issue title, if needed provide a concise description of changes.
178178
Please do not forget to add the issue URL to the commit message. This is used to link with GitHub issue.
179179

180+
## Using Github Copilot Agent
181+
182+
Using the [Github Copilot Agent](https://docs.github.com/en/copilot/concepts/agents/coding-agent/about-coding-agent) can boost your productivity and provide interesting insights as it allows to fire up a prompt and refine the results or build up on the analysis results.
183+
Due to current limitations using this directly against the base repository has some drawbacks:
184+
185+
- Copilot can currently not use a fork, so the branch is created directly on the repository which is against the recommended fork-based workflow.
186+
- Copilot currently cannot squash and force push a branch.
187+
- GitHub does not support filtering of individual notifications, due to the high cadence and the incremental work mode in some cases this can easily flood the inbox of subscribers of the repository.
188+
- If the task is not properly written or the problem is too complex, it can result in creating something off the track that needs to be discarded and then iterate again which results in more churn.
189+
190+
Because of this we recommend the following workflow:
191+
192+
- Let copilot work on your fork. For this one should sync the fork which can be done though the [web UI](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork).
193+
- Instead of assigning copilot an an issue, simply reference the issue in the prompt, e.g., `Analyze and propose a fix for <link to the original issue>`.
194+
- If you are happy with the result or would like to further refine it yourself), just fetch the branch from your fork, squash all commits, remove unnecessary files and force push the result to a new branch, e.g., usually copilot creates `copilot/fix-for-issue-123` so just push it as `fix-for-issue-123` and then open a PR against the repo as usual. This has the advantage that you can even ask copilot to refine some things later and then just merge the results into your local branch by a simple fetch!
195+
- Usually you want to leave copilot as the author and you as the committer, unless you have significantly rewritten the results, e.g., f it was mostly a research task and you did the actual implementation.
196+
180197
## Building the project on commandline
181198

182199
Even though most of the time you can work in the IDE it is sometime beneficial to build on the commandline as this is how we also execute the verification builds, also some test might not run at all in the IDE if they require a very specific setup,
@@ -203,4 +220,4 @@ for example you can run the tests and the bundle under test with the command `mv
203220
## Contact
204221

205222
- For official announcements, use the project's ["dev" mailing list](https://dev.eclipse.org/mailman/listinfo/platform-dev).
206-
- To ask for help, either use the current issue/PR or start a **GitHub Discussion**
223+
- To ask for help, either use the current issue/PR or start a **GitHub Discussion**

0 commit comments

Comments
 (0)