Skip to content

project-copilot/fit

Repository files navigation

CodeLab: Creating a Fitness App Using Project Copilot and GitHub Copilot

Summary

This CodeLab is a brief tutorial on how to utilize https://projectcopilot.co/ and GitHub Copilot in a small software development project.

Introduction to Project Copilot

Project Copilot

The Advantages of Project Copilot

  • With Project Copilot, receive assistance from an Artificial Intelligence system designed to enhance your Epics, User Stories, and Subtasks:
    • Leverages comprehensive data analysis and utilization of the Atlassian Knowledge Graph
      • Integrates relevant Confluence Design Documents
      • Incorporates related and linked Epics, User Stories and Subtasks
flowchart TD
    A[Atlassian Knowledge Graph] -->|Get context| B(Project Copilot)
    L[Document/Epic/User Story/SubTask] -->|Draft & Commands| B(Project Copilot)
    B --> C{Prompt Expert Engine}
    C -->|Improved| D[Epic/User Story/SubTask]
Loading

ChatGPT vs Project Copilot

  • Both provides Generative AI for Epics, User Stories and Sub Tasks
    • Why is better Project Copilot?
      • You don't need to write prompts from scratch
      • Context based on Atlassian Knowledge Graph
      • You can extend the prompt expert engine with commands
        • Current commands:
          • Instruction: user definition of the custom instruction
<technical-reference>User context for the technical reference </technical-reference>
flowchart TD
    A[Atlassian Knowledge Graph] -->|Get context| B(Project Copilot)
    L[Document/Epic/User Story/SubTask] -->|User Draft & Commands| B(Project Copilot)
    B --> C{Prompt Expert Engine}
    C -->|Improved| D[Document/Epic/User Story/SubTask]
    F[ChatGPT User Draft & Prompt] -->|Get context| G(ChatGPT)
    G --> H[Document/Epic/User Story/SubTask]
Loading

GitHub Copilot

  • Generative AI for Code
    • Based on
      • Previous code
      • Code comments
      • Chat
    • Cons
      • Deviation of code regarding requeriments for poor user stories
      • Rework because deviation
flowchart TD
    A[Previous Code] -->|Get context| D(GitHub Copilot)
    B[Code Comments] -->|Get context| D(GitHub Copilot)
    C[GitHub Chat] -->|Get context| D(GitHub Copilot)
    D(GitHub Copilot) --> E(New Code)
Loading

Project Copilot and GitHub Copilot

  • Generative AI for Project Planning (Epics, User Stories, Sub Tasks) and Code
    • Generate Epics, User Stories and Sub-Tasks
    • Use User Stories and Sub-Tasks for chat code generation
flowchart TD
    A[User Draft] -->|Get context| B(Project Copilot)
    B(Project Copilot) --> C(User Story)
    C(User Story) -->|Get context| D(GitHub Copilot Chat)
    D(GitHub Copilot Chat) --> E(New Code)
Loading

Project Copilot for Semantic Validation

  • Automatic semantic description for code of pull requests (PR)
  • Validation of semantic description of PR regarding user stories
flowchart TD
    A[User Draft] -->|Get context| B(Project Copilot)
    B(Project Copilot) --> C(User Story)
    C(User Story) -->|Get context| D(GitHub Copilot Chat)
    D(GitHub Copilot Chat) --> E(New Code)
    E(New Code) --> F(PR)
    F(PR) --> |Get context|G(Project Copilot)
    G(Project Copilot) --> H(PR Semantic Description)
    H(PR Semantic Description) --> I(Semantic Validation)
Loading

CodeLab

The CodeLab provides an initial version of the project as a starting point. This version was exclusively created by a human, with the constraint of completing the project epics, user stories, sub-tasks, code, and peer reviews in a maximum of 10 hours. The goal of the CodeLab is to gradually recreate the same project with the assistance of Project Copilot and GitHub Copilot in less than 1 hour to finally compare both projects, and get metrics about the planning and implementation.

The project's objective is to develop a compact client-side fitness application using HTML and JavaScript. This application should be capable of interfacing with the Google Fit REST API and computing daily calorie consumption based on the number of steps taken. Additionally, it should calculate a health score derived from these calories and "heart points."

Requirements

Project Copilot:

Link to install Project Copilot for Jira (Beta): Project Copilot for Jira on Atlassian Marketplace

Link to install Project Copilot for Confluence (Alpha): Project Copilot for Confluence Alpha version 0.1

GitHub Copilot:

GitHub Copilot

PR-Agent:

PR-Agent

About

Demo fitness app for Project Copilot codeLab

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages