Skip to content

Commit a0959f6

Browse files
omprakash970omprakash970
authored
Initial commit
0 parents  commit a0959f6

21 files changed

+1387
-0
lines changed

‎.devcontainer/devcontainer.json‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
{
2+
"name": "Python 3",
3+
"image": "mcr.microsoft.com/vscode/devcontainers/python:3.13",
4+
"customizations": {
5+
"vscode": {
6+
"extensions": [
7+
"GitHub.copilot",
8+
"ms-python.python",
9+
"ms-python.debugpy",
10+
"ms-vscode.live-server",
11+
"mechatroner.rainbow-csv"
12+
],
13+
"settings": {
14+
"livePreview.openPreviewTarget": "External Browser",
15+
"chat.implicitContext.suggestedContext": false,
16+
17+
// These are defaults but keeping them here for clarity and explicitness
18+
"github.copilot.chat.codeGeneration.useInstructionFiles": true,
19+
"chat.promptFilesLocations": {
20+
".github/prompts": true
21+
},
22+
"chat.instructionsFilesLocations": {
23+
".github/instructions": true
24+
},
25+
"chat.modeFilesLocations": {
26+
".github/chatmodes": true
27+
}
28+
}
29+
}
30+
}
31+
}

‎.github/ISSUE_TEMPLATE/add-update-content-to-process-docs.yml‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
name: "Add Content to Project Management Process Docs"
2+
description: "Request to add new content or updates to an existing program management process document."
3+
title: "[Process Doc Update]: "
4+
labels: ["documentation", "process improvement"]
5+
body:
6+
- type: dropdown
7+
id: process_doc
8+
attributes:
9+
label: "Which process document do you want to update? (If this is a new document, select '<new document>')"
10+
description: "Select the program management process document you want to add content to. If this is a new process doc, choose '<new document>'."
11+
options:
12+
- octoacme-project-management-overview.md
13+
- octoacme-project-initiation.md
14+
- octoacme-project-planning.md
15+
- octoacme-execution-and-tracking.md
16+
- octoacme-risks-and-communication.md
17+
- octoacme-release-and-deployment.md
18+
- octoacme-retrospective-and-continuous-improvement.md
19+
- octoacme-roles-and-personas.md
20+
- <new document>
21+
validations:
22+
required: true
23+
24+
- type: textarea
25+
id: content_summary
26+
attributes:
27+
label: "Summary of New Content"
28+
description: "Briefly describe the new content or update you want to add."
29+
placeholder: "E.g., Add clarification to risk escalation paths, new checklist for releases, additional role responsibilities, etc."
30+
validations:
31+
required: true
32+
33+
- type: textarea
34+
id: rationale
35+
attributes:
36+
label: "Why is this update needed?"
37+
description: "Explain the reason for this addition. Is it to address a gap, improve clarity, incorporate a best practice, etc.?"
38+
placeholder: "E.g., Identified gap in process, team feedback, alignment with industry standards, etc."
39+
validations:
40+
required: true
41+
42+
- type: textarea
43+
id: example_content
44+
attributes:
45+
label: "Suggested Content (optional)"
46+
description: "Paste the proposed new text, checklist, diagram, or example content you'd like to add. (Optional)"
47+
placeholder: "E.g., - New checklist items, - Copy for a new section, - Example scenario, etc."
48+
49+
- type: checkboxes
50+
id: acceptance_criteria
51+
attributes:
52+
label: "Acceptance Criteria"
53+
description: "Check all that apply:"
54+
options:
55+
- label: "Content aligns with existing process docs"
56+
- label: "Update improves clarity or closes a documented gap"
57+
- label: "Proposed content has been reviewed with stakeholders (if needed)"

‎.github/steps/1-step.md‎

Lines changed: 139 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
1+
## Step 1: Create and prime your Copilot Space
2+
3+
In this step you will establish a Copilot Space and give it the minimum context it needs to act as a project management knowledge hub for OctoAcme.
4+
5+
### How does using Spaces affect my usage?
6+
7+
Questions you submit in a space count as Copilot Chat requests.
8+
9+
- If you're a Copilot Free user, this usage counts toward your monthly chat limit.
10+
- If you use Spaces with a premium model, this usage counts toward your premium usage quota. Every question you submit to a premium model counts as one premium request, multiplied by the model's multiplier. For information about the multipliers applied to each model, see [Requests in GitHub Copilot](https://docs.github.com/en/copilot/managing-copilot/understanding-and-managing-copilot-usage/understanding-and-managing-requests-in-copilot#model-multipliers).
11+
12+
- [Use Copilot Spaces](https://docs.github.com/en/copilot/how-tos/provide-context/use-copilot-spaces/)
13+
14+
### 📖 Theory: Using Copilot Spaces as a Knowledge Hub
15+
16+
GitHub Copilot Spaces enables teams to centralize and democratize organizational knowledge by providing a collaborative environment for storing, searching, and refining process documentation. By connecting your repository as a source, Copilot Spaces can index your documentation and issue templates, making them easily accessible and actionable for all team members. This approach reduces single-person dependency risk, accelerates onboarding, and ensures that project management processes are consistent and repeatable.
17+
18+
To get started, you need access to Copilot Spaces and a GitHub Copilot plan with premium request units. Each prompt in a Space counts toward your usage quota, so be mindful of your plan's limits. For more details, see [GitHub Copilot plans](https://docs.github.com/en/copilot/get-started/plans#comparing-copilot-plans) and [Copilot Requests](https://docs.github.com/en/copilot/concepts/billing/copilot-requests).
19+
20+
> [!NOTE]
21+
> Questions you submit in a Copilot Space count as Copilot Chat requests. Premium models multiply usage. See [Requests in GitHub Copilot](https://docs.github.com/en/copilot/managing-copilot/understanding-and-managing-copilot-usage/understanding-and-managing-requests-in-copilot#model-multipliers) for details.
22+
23+
### ⌨️ Activity: Create your OctoAcme Project Management Hub Copilot Space
24+
25+
1. Navigate to GitHub Copilot Spaces https://github.com/copilot/spaces (ensure you have access to this feature)
26+
1. Click **Create Space** button
27+
1. Name your Space:
28+
29+
> ```text
30+
> OctoAcme Project Management Hub
31+
> ```
32+
33+
1. Click **Save**
34+
35+
<img width="50%" height="50%" alt="Copilot Space Create Space" src="https://github.com/user-attachments/assets/0dcc4d78-1ee0-43cf-85c8-c1d0137aceb0" />
36+
37+
Add a description:
38+
39+
> ```text
40+
> Centralizing and democratizing project management knowledge for the OctoAcme organization
41+
> ```
42+
43+
<img width="50%" height="50%" alt="Copilot Spaces description" src="https://github.com/user-attachments/assets/5826b4bc-a40b-4705-b36a-66b234c2c07d" />
44+
45+
### ⌨️ Activity: Add instructions to your Copilot Space
46+
47+
- In your newly created Copilot Space, look for the **Instructions** button
48+
- Add the following instructions to provide context about the repository and its purpose
49+
50+
<img width="50%" height="50%" alt="Copilot Spaces Instructions" src="https://github.com/user-attachments/assets/547cdbf9-9238-42af-a06b-7bb168207ec2" />
51+
<img width="50%" height="50%" alt="Copilot Spaces Instructions detail" src="https://github.com/user-attachments/assets/628b8534-5f14-48ba-89dc-16eec79617ea" />
52+
53+
- Click **Save**
54+
55+
> ```markdown
56+
> ## Program process documents
57+
>
58+
> - Stored in `docs/`
59+
>
60+
> ### Purpose of this Copilot Space
61+
>
62+
> - Centralize scattered project management knowledge in Copilot Spaces
63+
> - Convert tacit team insights into searchable, versioned artifacts
64+
> - Give all team members equal access to processes, decisions, and rationale
65+
> - Connect a repository as a structured knowledge source
66+
> - Extract, refine, and standardize workflows collaboratively
67+
> - Feed validated improvements back into living documentation
68+
> - Accelerate onboarding and reduce single-person dependency risk
69+
> - Enable consistent, repeatable project execution
70+
>
71+
> ## Issue templates for program process documents
72+
>
73+
> - Stored in `.github/ISSUE_TEMPLATE/`
74+
> ```
75+
76+
### ⌨️ Activity: Add your cloned repository as a source repository to your Copilot Space
77+
78+
1. In your newly created Copilot Space, look for **Add sources** button
79+
1. Add this exercise repository as a source:
80+
81+
- Copy and paste your GitHub repository for this exercise called out below.
82+
- You can also type the name in the search and it will come up as well or copy/paste the name below.
83+
84+
> ```text
85+
> {{full_repo_name}}
86+
> ```
87+
88+
- This gives Copilot access to the project management documentation and processes in the repository
89+
90+
1. Select the `docs` and the `.github/ISSUE_TEMPLATE` folders
91+
1. Verify the repository appears in your sources list
92+
93+
<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/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" />
96+
97+
### ⌨️ Activity: Create an issue in the repository for a README for OctoAcme Project Management Docs
98+
99+
- Open your Copilot Space you created above. https://github.com/copilot/spaces
100+
- In the conversation interface prompt the following:
101+
102+
> ![Static Badge](https://img.shields.io/badge/-Prompt-text?style=social&logo=github%20copilot)
103+
>
104+
> ```prompt
105+
> Create an issue in the repository {{full_repo_name}} for a README for OctoAcme Project Management Docs
106+
> that has links to all the docs in the docs folder.
107+
> - The README should also contain a brief summary of the project management processes used by OctoAcme.
108+
> - 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
112+
> ```
113+
114+
You can then add this issue to your repository by clicking the **Create** button.
115+
116+
<details>
117+
<summary> 📷 Show screenshot of the issue draft</summary>
118+
119+
<img width="50%" height="50%" alt="README issue drafted" src="https://github.com/user-attachments/assets/fd324605-a02b-4d4a-a87f-06db9339bb44" />
120+
121+
</details>
122+
You can copy or open the link in a new tab to see the newly created issue
123+
124+
<details>
125+
<summary> 📷 Show screenshot of the created issue</summary>
126+
127+
<img width="50%" height="50%" alt="README issue created" src="https://github.com/user-attachments/assets/c4be58b8-edbf-463a-be49-8ad184d59617" />
128+
129+
</details>
130+
131+
<details>
132+
<summary>Having trouble? 🤷</summary>
133+
134+
- Make sure you have access to GitHub Copilot Spaces (currently in beta/limited access)
135+
- The repository should be publicly accessible for Copilot to index it
136+
- If you can't access Copilot Spaces, you can continue by manually exploring the repository structure and documentation
137+
- Repository indexing can take seconds to minutes depending on size
138+
139+
</details>

‎.github/steps/2-step.md‎

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
## Step 2: Explore & summarize project management processes and create a README
2+
3+
In this step you will:
4+
5+
- Explore the process docs in the docs/ folder (e.g., project-lifecycle.md, roles-responsibilities.md, communication-plan.md)
6+
- Generate a 3–4 paragraph summary in your Copilot Space (workflows, roles, communication, quality)
7+
- Use that summary to create/attach the existing issue about the README
8+
- Create a pull request adding a README that links all process docs and includes the brief overview
9+
10+
### 📖 Theory: Attaching issues and assigning to the GitHub Copilot coding agent
11+
12+
While reading, note:
13+
14+
- End-to-end workflow stages and handoffs
15+
- Defined roles/personas and responsibilities
16+
- Decision / escalation points
17+
- Communication cadences and channels
18+
- Quality gates, reviews, and acceptance criteria
19+
20+
You will use the prompts below to:
21+
22+
1. Summarize the docs
23+
2. Attach the prior issue
24+
3. Generate a PR adding a docs/ README with links + overview
25+
26+
Proceed to the activities and run the provided prompts in your Copilot Space.
27+
28+
### ⌨️ Activity: Explore the project management process docs and Summarize in your Copilot Space
29+
30+
- Generate a summary. Should be 3-4 paragraphs covering the main processes OctoAcme uses for project management.
31+
- Open your Copilot Space you created in the previous step. https://github.com/copilot/spaces or by clicking the name <img width="50%" height="50%" alt="link to Copilot Space" src="https://github.com/user-attachments/assets/13534299-c764-4d20-9760-88bd7dac7cff" />
32+
- Start a new conversation in the Copilot Space and prompt the following:
33+
<img width="70%" height="70%" alt="Copilot Space conversation OctoAcme project management process docs summary" src="https://github.com/user-attachments/assets/342605be-4b36-48b2-b54f-18ae85f16bb8" />
34+
35+
> ![Static Badge](https://img.shields.io/badge/-Prompt-text?style=social&logo=github%20copilot)
36+
>
37+
> ```prompt
38+
> - Create a 3-4 paragraph summary of the project management processes used by OctoAcme
39+
> based on the documentation in the docs folder of this repository.
40+
> - Focus on key workflows, personas/roles, communication strategies, and quality assurance practices.
41+
> ```
42+
43+
<details>
44+
<summary> 📷 Show screenshot of the conversation output</summary>
45+
46+
<img width="50%" height="50%" alt="Copilot response with the summary" src="https://github.com/user-attachments/assets/26a54642-a14b-498d-a195-d1ffd45e5679" />
47+
48+
</details>
49+
50+
### ⌨️ Activity: Attach an issue and create a pull request for the Copilot coding agent
51+
52+
In this activity, you will connect the issue you created in Step 1 to your Copilot Space conversation and use the coding agent to automatically create a pull request.
53+
54+
1. **Find your issue number**: Go to [https://github.com/{{full_repo_name}}/issues](https://github.com/{{full_repo_name}}/issues) and note the issue number from Step 1 (it should be about creating a README for project management docs)
55+
56+
1. **Attach the issue to your conversation**: In your Copilot Space, type the following (replace `#` with your actual issue number):
57+
58+
> [!IMPORTANT]
59+
> After typing the issue reference below, press **\<SHIFT\> + \<ENTER\>** to add it to the conversation without sending the message yet.
60+
61+
```text
62+
@{{full_repo_name}}/issues/#
63+
```
64+
65+
(Example: if your issue is #2, type `@{{full_repo_name}}/issues/2`)
66+
67+
1. **Verify the issue is attached**: You should see the issue title and details appear in your conversation
68+
69+
1. **Create the pull request**: Now send this prompt to create the pull request:
70+
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+
73+
> ![Static Badge](https://img.shields.io/badge/-Prompt-text?style=social&logo=github%20copilot)
74+
>
75+
> ```prompt
76+
> - Using the github-coding-agent tool create a pull request based on the attached issue.
77+
> - The README should also contain a brief overview of the project management processes
78+
> used by OctoAcme based on the summary we just created.
79+
> - The README should be in the `docs/` folder
80+
> - Add this pull request to the attached issue.
81+
> - Add {{login}} as a reviewer for the pull request
82+
> ```
83+
84+
1. **Allow the coding agent**: When prompted, select **Allow** to let the coding agent work on your repository
85+
86+
<img width="50%" height="50%" alt="Copilot coding agent allow" src="https://github.com/user-attachments/assets/b0c92c04-d12b-4c5e-b682-33643b90ee11" />
87+
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 progress:
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+
> ```
107+
108+
<img width="40%" height="40%" alt="mission control" src="https://github.com/user-attachments/assets/ef0ffd8a-ba8f-4618-a2cc-8e1e0d1bb309" />
109+
110+
> [!NOTE]
111+
> The coding agent typically takes 5-15 minutes to complete the work. You can click **View session** to watch the progress if desired.
112+
113+
1. **Review and merge**: Once the pull request is ready:
114+
115+
a. **Submit review**: Leave a comment (optional), click **Approve**, then **Submit review**
116+
117+
<img width="70%" height="70%" alt="Add review" src="https://github.com/user-attachments/assets/ea460dc3-a86d-467b-8469-bd9244b915ea" />
118+
119+
<img width="50%" height="50%" alt="Submit review" src="https://github.com/user-attachments/assets/15042891-c8fa-4acc-a25d-c588cf6a3ffe" />
120+
121+
b. **Merge**: Select **Ready for review**, then **Merge pull request** and **Confirm merge**
122+
123+
<img width="50%" height="50%" alt="Ready for review" src="https://github.com/user-attachments/assets/2348378d-a597-404f-827d-4003d79055c0" />
124+
<img width="50%" height="50%" alt="Merge pull request" src="https://github.com/user-attachments/assets/fda15799-a123-4e6a-b32a-c7ec44db3418" />
125+
126+
<details>
127+
<summary>Having trouble? 🤷</summary>
128+
129+
- **Can't find your issue?** Check the [Issues tab](https://github.com/{{full_repo_name}}/issues) in your repository for the issue you created in Step 1
130+
- **Issue not attaching?** Make sure you're using the exact format `@{{full_repo_name}}/issues/#` where `#` is your issue number
131+
- **Coding agent not working?** Ensure you have the necessary permissions to create pull requests in your repository
132+
- **Pull request creation failed?** The issue must be properly attached before the coding agent can work on it
133+
134+
</details>

0 commit comments

Comments
 (0)