Giter Club home page Giter Club logo

userstoryenhancer's Introduction

Enhanced User Story Function App

Overview

This repository contains an Azure Function App that enhances user stories. Given a user story string, the function leverages LangChain and OpenAI's API to return a JSON object with an enhanced user story and an array of acceptance criteria. This could be seamlessly integrated with task management tools like Jira, Asana, Trello, etc. providing recommendations or improvements upon the creation of a new user story.

Features

  • Enhances user stories by tapping into the power of OpenAI's API.
  • Returns structured JSON response containing both the improved user story and the corresponding acceptance criteria.
  • Can be easily triggered from various task management platforms upon the creation of a new user story.

Local Development

Prerequisites

  1. Storage Account: The function requires a storage account. For local development, you can use Azurite, a local storage emulator.
  2. VS Code: This readme assumes you are using VS Code for local development. Install the Azure Functions extension for a smoother experience.

Setup & Running Locally

  1. Azurite Installation and Setup:
    • Follow the documentation here to set up Azurite for local storage emulation.
    • Once set up, use the VS Code command palette to start Azurite.
  2. Running the Function:
    • Press F5 in the azure function file to start the function.
    • Navigate to the Azure extension, workspace, local project, functions, then EnhancedUserStory.
    • Right-click on the function and select 'execute function now' to run it.

Updates & Enhancements

  • Refactored Input: The hardcoded user story has been removed. The function now accepts user stories from the HTTP request.
  • OpenAI Instance Refinement: The global llm instance is now utilized and initialized only if not already. This provides better resource management.
  • Response Handling: Code has been updated to extract the relevant information from the OpenAI response, providing concise and meaningful output.
  • Error Handling: Added a try-catch block to handle potential errors and to ensure that the function responds gracefully.

Contribution & Feedback

Feel free to fork the repository, submit pull requests, or provide feedback on enhancements and improvements. Your collaboration is welcome!

License

This project is licensed under the MIT License - see the LICENSE.md file for details.


By leveraging the power of machine learning, this function aims to improve the quality and consistency of user stories across projects. Thank you for your interest and support!

userstoryenhancer's People

Contributors

nsmaassel avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.