Skip to content

Commit ab13ed0

Browse files
authored
Update README.md
1 parent 42b2e09 commit ab13ed0

File tree

1 file changed

+27
-18
lines changed

1 file changed

+27
-18
lines changed

README.md

Lines changed: 27 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,36 +2,44 @@
22
<img width="807" alt="image" src="https://github.com/martedesco/copilot-metrics-viewer/assets/3329307/3865c1c1-f087-4f87-b3ad-8550b3cb355b">
33
</p>
44

5-
## Charts and Data Visualizations
5+
## Video
66

7-
This application displays a set of charts to visualize various metrics related to GitHub Copilot for your organization leveraging the GitHub Copilot Metrics API, current distributed in private alpha. These visualizations are designed to provide clear representations of the data, making it easy to understand and analyze the impact and usage of GitHub Copilot. Here are the key metrics visualized in these charts:
7+
https://github.com/martedesco/copilot-metrics-viewer/assets/3329307/6d5b3ffd-ef4f-4c47-b0fe-177181fabd99
88

9-
### Key Metrics
9+
## Charts
1010

11-
1. **Total Suggestions:** This chart illustrates the total number of code suggestions made by GitHub Copilot. It offers a view of the tool's activity and its engagement with users over time.
12-
13-
2. **Total Acceptances:** This visualization focuses on the total number of suggestions accepted by users. This metric is crucial to understand the effectiveness and accuracy of GitHub Copilot's suggestions.
11+
This application includes a set of charts to visualize various metrics related to GitHub Copilot for your _GitHub Organization_. These visualizations are designed to provide clear representations of the data, making it easy to understand and analyze the impact and adoption of GitHub Copilot.
1412

13+
## Key Metrics
14+
Here are the key metrics visualized in these charts:
15+
1. **Acceptance Rate:** This metric represents the ratio of accepted lines to the total lines suggested by GitHub Copilot. This rate is an indicator of the relevance and usefulness of Copilot's suggestions.
1516
<p align="center">
16-
<img width="600" alt="image" src="https://github.com/martedesco/copilot-metrics-viewer/assets/3329307/b3b8ce00-26e1-424e-9bd6-000f2245ad6b">
17+
<img width="600" alt="image" src="https://github.com/martedesco/copilot-metrics-viewer/assets/3329307/875a5f5f-5d8a-44bd-a4e9-0f663f2b2628">
1718
</p>
1819

19-
4. **Total Lines Suggested:** A detailed chart showcasing the total number of lines of code suggested by GitHub Copilot. This gives an idea of the volume of code generation and assistance provided.
20+
3. **Total Suggestions** This chart illustrates the total number of code suggestions made by GitHub Copilot. It offers a view of the tool's activity and its engagement with users over time.
21+
22+
4. **Total Acceptances:** This visualization focuses on the total number of suggestions accepted by users.
2023

21-
5. **Total Lines Accepted:** This chart compares the total lines of code accepted by users, offering insights into how much of the suggested code is actually being utilized in real-world applications.
2224
<p align="center">
23-
<img width="600" alt="image" src="https://github.com/martedesco/copilot-metrics-viewer/assets/3329307/8c63920e-35e7-4a09-a7bc-2df2f5f03492">
25+
<img width="600" alt="image" src="https://github.com/martedesco/copilot-metrics-viewer/assets/3329307/b84220ae-fbdc-4503-b50b-4689362bf364">
2426
</p>
2527

26-
6. **Total Active Users:** An interactive graph representing the number of active users engaging with GitHub Copilot. This helps in understanding the tool's popularity and user base growth.
28+
4. **Total Lines Suggested:** Showcases the total number of lines of code suggested by GitHub Copilot. This gives an idea of the volume of code generation and assistance provided.
29+
30+
5. **Total Lines Accepted:** As the name says, the total lines of code accepted by users (full acceptances) offering insights into how much of the suggested code is actually being utilized incorporated to the codebase.
2731

2832
<p align="center">
29-
<img width="600" alt="image" src="https://github.com/martedesco/copilot-metrics-viewer/assets/3329307/879d627c-0267-456e-b456-a583d1ca368a">
33+
<img width="600" alt="image" src="https://github.com/martedesco/copilot-metrics-viewer/assets/3329307/788c9b33-8e63-43a5-9ab9-98d8938dd9d9">
3034
</p>
3135

36+
6. **Total Active Users:** Represents the number of active users engaging with GitHub Copilot. This helps in understanding the user base growth and adoption rate.
3237

38+
<p align="center">
39+
<img width="600" alt="image" src="https://github.com/martedesco/copilot-metrics-viewer/assets/3329307/bd92918f-3a11-492b-8490-877aaa768ca3">
40+
</p>
3341

34-
### Language Breakdown Analysis
42+
## Language Breakdown Analysis
3543

3644
The language breakdown analysis at the bottom of the page displays a table showing the Accepted Prompts, Accepted Lines of Code, and Acceptance Rate (%) for each language over the full time period covered by a single API call.
3745

@@ -41,11 +49,12 @@ The language breakdown analysis at the bottom of the page displays a table showi
4149

4250
## Requirements
4351

44-
Your organization must be enrolled in the [GitHub Copilot API private alpha]([url](https://docs.github.com/en/early-access/copilot/copilot-usage-api)).
52+
Your organization must be enrolled in the GitHub Copilot API private alpha.
4553

46-
## Project setup
54+
## Setup instructions
4755

48-
Edit the .env file in the root directory of the project and add the following variables:
56+
- Instrucions on how to authenticate are provided in the API documentation - available if you have access to the private alpha.
57+
- Edit the .env file in the root directory of the project and add the following variables:
4958

5059
```
5160
VUE_APP_GITHUB_ORG=
@@ -73,5 +82,5 @@ npm run build
7382
npm run lint
7483
```
7584

76-
### Coming soon 🔮
77-
Enterprise level charts
85+
### Coming next 🔮
86+
- Enterprise level charts

0 commit comments

Comments
 (0)