PROJECT SETUP
INTRODUCTION
This document is part of our Getting Started Guide to setup your plugin and start to generate User Stories, Epic, Test Cases, Code and more by using ChatGPT.
To start your setup you need to Sign Up in our platform and setup your plugin.
Setting Project Description for Chat GPT Context
As you may already know, Chat GPT performs better when it has more context. In that way, we use the project description to provide project context to the Open AI model. For this reason, we strongly recommend setting the project description.
To help improve the performance of MyAgileCopilot, we recommend adding a project description of 50 to 150 words.
This will provide additional context for Chat GPT and help it generate more accurate content for your issues. To add a project description, follow these steps:
Access your project settings by clicking the bottom-left corner of the menu.
Click on "Workflow" and type in a description of 50 to 150 words.
Save your changes.
Now, you can setup this description from the project settings page too.
SETUP JIRA Workflow
One of the key benefits of using myAgileCopilot is the ability to integrate AI-generated content creation into your project methodology. To enable this functionality, we require certain statuses to be available within your project workflows.
You need to setup the workflow including NEW and READY TO TEST statuses. To do that you can follow next steps with admin role:
Access to the Project Settings (in the left - bottom part of the menu)
Click in workflow
Edit workflows of SUBTASK and USER STORIES
Ensure that the workflows for subtasks and user stories include the following statuses: NEW, TO DO, IN PROGRESS, READY TO TEST, and DONE. You can have additional statuses, but these five are the minimum required for myAgileCopilot integration
SET YOUR TECH STACK AS JIRA COMPONENTS
As you probably know, chat GPT works better if it has more context. On the technical side, we will use components to organize your development and to provide a better context of your project to ChatGPT.
To ensure consistency and maintainability in your project, it's essential to define your architecture and tech stack and organize them into components. When creating a component, you should provide a detailed description that includes:
The Base technology and framework you'll be using.
A list of all the libraries you plan to use, such as CSS framework, Form Validation tools, i18n libraries, ORM, authentication libraries, query string validation tools, etc. You don't need to describe each library or technology in detail.
An identification of all the dependencies your component will have with other components.
Documentation standards to ensure your component is well-documented and easy to understand.
Testing standards to ensure your component is thoroughly tested and free of bugs.
Be sure to provide comprehensive descriptions, but try to keep them concise and to the point.