Skip to content

Commit 8b271d0

Browse files
authored
Update image (#22)
* make updates to activity directions in the prompts * Enhance documentation for coding agent usage Added instructions for monitoring coding agent progress and checking open pull requests. * Change image for pull request creation instructions Updated image source for pull request creation step. * Replace images in 1-step.md with updated sources Updated images in the step-by-step guide for clarity. * Replace issue draft and created issue screenshots Updated screenshots for issue draft and created issue sections. * Adjust image sizes and alt text in 3-step.md Updated image sizes and alt text in the documentation for clarity and consistency.
1 parent 120d86d commit 8b271d0

File tree

3 files changed

+69
-32
lines changed

3 files changed

+69
-32
lines changed

.github/steps/1-step.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,8 @@ Add a description:
9191
1. Verify the repository appears in your sources list
9292
9393
<img width="30%" height="30%" alt="Add sources" src="https://github.com/user-attachments/assets/05268c3f-5270-4e60-bc87-69fc27b1df72" />
94-
<img width="30%" height="30%" alt="Add sources repository" src="https://github.com/user-attachments/assets/d8b38b95-98ca-44a3-b7b4-d1ab4c12d348" />
95-
<img width="30%" height="30%" alt="Add sources repository files" src="https://github.com/user-attachments/assets/8340a69c-0d05-49df-92e7-bf929b57443b" />
94+
<img width="30%" height="30%" alt="Add sources repository" src="https://github.com/user-attachments/assets/83725fcc-eb0d-4478-ba88-8de0cd8a6732" />
95+
<img width="30%" height="30%" alt="Add sources repository files" src="https://github.com/user-attachments/assets/f3e9c65a-1446-4f1f-a84f-10f893d0e22e" />
9696
9797
### ⌨️ Activity: Create an issue in the repository for a README for OctoAcme Project Management Docs
9898
@@ -106,22 +106,25 @@ Add a description:
106106
> that has links to all the docs in the docs folder.
107107
> - The README should also contain a brief summary of the project management processes used by OctoAcme.
108108
> - Make sure README, project management processes summary, and links are in the title of the issue.
109+
> - Use the "Add Content to Project Management Process Docs" template.
110+
> - Which process document do you want to update? "<new document>"
111+
> - Fill in the other fields
109112
> ```
110113
111114
You can then add this issue to your repository by clicking the **Create** button.
112115
113116
<details>
114117
<summary> 📷 Show screenshot of the issue draft</summary>
115118
116-
<img width="50%" height="50%" alt="conversation to create an issue" src="https://github.com/user-attachments/assets/cc152bc6-d189-4143-8eea-719f70e43a6f" />
119+
<img width="50%" height="50%" alt="README issue drafted" src="https://github.com/user-attachments/assets/fd324605-a02b-4d4a-a87f-06db9339bb44" />
117120
118121
</details>
119122
You can copy or open the link in a new tab to see the newly created issue
120123
121124
<details>
122125
<summary> 📷 Show screenshot of the created issue</summary>
123126
124-
<img width="50%" height="50%" alt="cs-9" src="https://github.com/user-attachments/assets/a174f9cc-6c28-4698-a9b0-9e61e711413a" />
127+
<img width="50%" height="50%" alt="README issue created" src="https://github.com/user-attachments/assets/c4be58b8-edbf-463a-be49-8ad184d59617" />
125128
126129
</details>
127130

.github/steps/2-step.md

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,8 @@ In this activity, you will connect the issue you created in Step 1 to your Copil
6868

6969
1. **Create the pull request**: Now send this prompt to create the pull request:
7070

71-
<img width="80%" height="80%" alt="repository issue and pull request creation" src="https://github.com/user-attachments/assets/aab825e3-53bb-40e7-adbd-efbae520293d" />
72-
71+
<img width="80%" height="80%" alt="repository issue and pull request creation" src="https://github.com/user-attachments/assets/af469c6a-fc87-454b-9a65-23ffe0d7cd50" />
72+
7373
> ![Static Badge](https://img.shields.io/badge/-Prompt-text?style=social&logo=github%20copilot)
7474
>
7575
> ```prompt
@@ -78,16 +78,34 @@ In this activity, you will connect the issue you created in Step 1 to your Copil
7878
> used by OctoAcme based on the summary we just created.
7979
> - The README should be in the `docs/` folder
8080
> - Add this pull request to the attached issue.
81-
> - Add {{login}} as a reviewer
81+
> - Add {{login}} as a reviewer for the pull request
8282
> ```
8383
8484
1. **Allow the coding agent**: When prompted, select **Allow** to let the coding agent work on your repository
8585
8686
<img width="50%" height="50%" alt="Copilot coding agent allow" src="https://github.com/user-attachments/assets/b0c92c04-d12b-4c5e-b682-33643b90ee11" />
8787
88-
1. **Monitor progress**: You should receive a notification that the Copilot coding agent is working on your pull request. Go to your repository and click **Pull requests** to see the progress:
88+
1. **Monitor progress**: You should receive a notification that the Copilot coding agent is working on your pull request.
89+
90+
There are two ways you can check the status of the coding agent working on your pull request
91+
92+
1. Go to your repository and click **Pull requests** to see the progressor:
93+
94+
<img width="70%" height="70%" alt="pull requests" src="https://github.com/user-attachments/assets/88e9876e-2dae-43a4-86ff-29c4cdc6077c" />
95+
96+
1. You can track progress and view details in **Mission Control** for **agent tasks** by following the task link
97+
98+
<img width="40%" height="40%" alt="mission control" src="https://github.com/user-attachments/assets/a64c1826-720e-4b5f-8d0f-8aebc9aca501" />
99+
100+
1. **Check open pull requests**: We can check pull request status from our **Copilot Space** as well.
101+
102+
> ![Static Badge](https://img.shields.io/badge/-Prompt-text?style=social&logo=github%20copilot)
103+
>
104+
> ```prompt
105+
> check open pull requests
106+
> ```
89107
90-
<img width="70%" height="70%" alt="pull requests" src="https://github.com/user-attachments/assets/d30685c3-046b-4c6e-8254-4bcb8aa959b5" />
108+
<img width="40%" height="40%" alt="mission control" src="https://github.com/user-attachments/assets/ef0ffd8a-ba8f-4618-a2cc-8e1e0d1bb309" />
91109
92110
> [!NOTE]
93111
> The coding agent typically takes 5-15 minutes to complete the work. You can click **View session** to watch the progress if desired.

.github/steps/3-step.md

Lines changed: 39 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,10 @@ _Use the following prompt in a new Copilot Space conversation:_
3434
- Select the issue template to this new Copilot Space conversation. </br>
3535
`.github/ISSUE_TEMPLATE/add-update-content-to-process-docs.yml`
3636
37-
<img width="50%" height="50%" alt="Attach" src="https://github.com/user-attachments/assets/2a447ff9-76d7-462f-9292-4663c8dc0fc9" />
38-
37+
<img width="30%" height="30%" alt="Attach" src="https://github.com/user-attachments/assets/2a447ff9-76d7-462f-9292-4663c8dc0fc9" />
3938
<img width="30%" height="30%" alt="Attach files" src="https://github.com/user-attachments/assets/6ac6e33d-b333-424f-b431-e3feb7022b841" />
4039
41-
<img width="50%" height="50%" alt="Attach issue template" src="https://github.com/user-attachments/assets/c02537ad-173e-430d-9e24-6a95763b8f30" />
42-
43-
<img width="60%" height="60%" alt="Attach issue template conversation" src="https://github.com/user-attachments/assets/9a1a06b1-60fe-4794-a2a9-69d09aeab47f" />
40+
<img width="30%" height="30%" alt="Attach issue template conversation" src="https://github.com/user-attachments/assets/5fc71905-ede6-45cb-bcfa-93d2797160b2" />
4441
4542
> ![Static Badge](https://img.shields.io/badge/-Prompt-text?style=social&logo=github%20copilot)
4643
>
@@ -54,10 +51,11 @@ _Use the following prompt in a new Copilot Space conversation:_
5451
> - The issue should detail why this is important, potential personas to add, and how it will improve project outcomes.
5552
> - add to the process document `docs/octoacme-roles-and-personas.md`
5653
> ```
57-
>
58-
> <img width="50%" height="50%" alt="personas/roles issue draft" src="https://github.com/user-attachments/assets/d3700d45-a16a-482a-b2e0-5310f80162b6" />
5954
60-
<img width="50%" height="50%" alt="personas/roles issue created" src="https://github.com/user-attachments/assets/c6e3f128-6254-4f0c-a1a6-f31b9d8b56b2" />
55+
<img width="50%" height="50%" alt="personas/roles issue draft" src="https://github.com/user-attachments/assets/cd02e396-2505-450a-aca3-8e1642d6306a" />
56+
57+
<img width="50%" height="50%" alt="personas/roles issue created" src="https://github.com/user-attachments/assets/7f30e13b-7efd-45a0-939a-e7095ff0637c" />
58+
6159
6260
### ⌨️ Activity: Attach an issue and create a Pull Request
6361
@@ -80,7 +78,7 @@ Check issues list: [https://github.com/{{full_repo_name}}/issues](https://github
8078
> @{{full_repo_name}}/issues/4
8179
> ```
8280
83-
<img width="50%" height="50%" alt="repository issue and pull request creation" src="https://github.com/user-attachments/assets/31955ab4-04f4-4316-811e-0c7234f02567" />
81+
<img width="40%" height="40%" alt="repository issue and pull request creation" src="https://github.com/user-attachments/assets/cf4f0c32-76cb-429d-b607-f65f444b07d5" />
8482
8583
> ![Static Badge](https://img.shields.io/badge/-Prompt-text?style=social&logo=github%20copilot)
8684
>
@@ -91,32 +89,50 @@ Check issues list: [https://github.com/{{full_repo_name}}/issues](https://github
9189
> - The pull request should include updates to existing docs or new templates/checklists as needed.
9290
> - All documents should be in the `docs/` folder
9391
> - Add this pull request to the attached issue.
94-
> - Add {{login}} as a reviewer
92+
> - Add {{login}} as a reviewer for this pull request
9593
> ```
9694
97-
Select **Allow**
95+
1. **Allow the coding agent**: When prompted, select **Allow** to let the coding agent work on your repository
9896
9997
<img width="50%" height="50%" alt="Copilot coding agent allow" src="https://github.com/user-attachments/assets/b0c92c04-d12b-4c5e-b682-33643b90ee11" />
10098
101-
You should have gotten a notification that Copilot coding agent is working on your pull request.
99+
1. **Monitor progress**: You should receive a notification that the Copilot coding agent is working on your pull request.
100+
101+
There are two ways you can check the status of the coding agent working on your pull request
102+
103+
1. Go to your repository and click **Pull requests** to see the progressor:
104+
105+
<img width="70%" height="70%" alt="pull requests" src="https://github.com/user-attachments/assets/88e9876e-2dae-43a4-86ff-29c4cdc6077c" />
106+
107+
1. You can track progress and view details in **Mission Control** for **agent tasks** by following the task link
108+
109+
<img width="40%" height="40%" alt="mission control" src="https://github.com/user-attachments/assets/a64c1826-720e-4b5f-8d0f-8aebc9aca501" />
110+
111+
1. **Check open pull requests**: We can check pull request status from our **Copilot Space** as well.
112+
113+
> ![Static Badge](https://img.shields.io/badge/-Prompt-text?style=social&logo=github%20copilot)
114+
>
115+
> ```prompt
116+
> check open pull requests
117+
> ```
118+
119+
<img width="40%" height="40%" alt="mission control" src="https://github.com/user-attachments/assets/66693282-e5f6-45d6-8ca8-968e73826738" />
102120
103-
Go to your repository and click **Pull requests** and you should see something similar to the following:
121+
> [!NOTE]
122+
> The coding agent typically takes 5-15 minutes to complete the work. You can click **View session** to watch the progress if desired.
104123
105-
<img width="70%" height="70%" alt="pull requests" src="https://github.com/user-attachments/assets/d30685c3-046b-4c6e-8254-4bcb8aa959b5" />
124+
1. **Review and merge**: Once the pull request is ready:
106125
107-
- It takes approximately 5 to 15 minutes for the coding agent to work on the issue.
108-
- If you would like to see how the Copilot coding agent is progressing you can click the **View session** button and interact in the session.
109-
- Once you are satisfied with the content **Submit review**, leave a comment (optional), click **Approve**, then **Submit review**
126+
a. **Submit review**: Leave a comment (optional), click **Approve**, then **Submit review**
110127
111-
<img width="70%" height="70%" alt="Add review" src="https://github.com/user-attachments/assets/ea460dc3-a86d-467b-8469-bd9244b915ea" />
128+
<img width="70%" height="70%" alt="Add review" src="https://github.com/user-attachments/assets/ea460dc3-a86d-467b-8469-bd9244b915ea" />
112129
113-
<img width="50%" height="50%" alt="Submit review" src="https://github.com/user-attachments/assets/15042891-c8fa-4acc-a25d-c588cf6a3ffe" />
114-
</br>
130+
<img width="50%" height="50%" alt="Submit review" src="https://github.com/user-attachments/assets/15042891-c8fa-4acc-a25d-c588cf6a3ffe" />
115131
116-
- At the bottom select **Ready for review** and then **Merge pull request** and **Confirm merge**
132+
b. **Merge**: Select **Ready for review**, then **Merge pull request** and **Confirm merge**
117133
118-
<img width="50%" height="50%" alt="Ready for review" src="https://github.com/user-attachments/assets/2348378d-a597-404f-827d-4003d79055c0" />
119-
<img width="50%" height="50%" alt="Merge pull request" src="https://github.com/user-attachments/assets/fda15799-a123-4e6a-b32a-c7ec44db3418" />
134+
<img width="50%" height="50%" alt="Ready for review" src="https://github.com/user-attachments/assets/2348378d-a597-404f-827d-4003d79055c0" />
135+
<img width="50%" height="50%" alt="Merge pull request" src="https://github.com/user-attachments/assets/fda15799-a123-4e6a-b32a-c7ec44db3418" />
120136
121137
<details>
122138
<summary>Having trouble? 🤷</summary>

0 commit comments

Comments
 (0)