Commit Teller - The beginning
Tags: githubhack23, java, github, githubaction
Published: 2023-04-27 18:10:52

---
title: Commit Teller - The beginning
published: true
series: Commit Teller - The Story
description: The story about Commit-teller
tags: #GitHubHack23, #java, #github, #githubaction
cover_image: https://dev-to-uploads.s3.amazonaws.com/uploads/articles/4b7mmdijrjww6v3zazad.png
# Use a ratio of 100:42 for best results.
# published_at: 2023-04-27 18:00 +0000
---

## Another tool for my daily job? But why? 

The idea for Commit Teller came after I read the official announcement about the **GitHubHack23** event, and started to think about a cool stuff that can utilize GitHub actions.

I use GitHub actions almost on a daily basis for my personal projects and for my projects under the [Rodnan Sol](https://github.com/rodnansol) organization. It is utilized to execute CI builds and to create releases for our applications. I used to use Bitbucket and GitLab and their CI solutions, GitHub Actions are not different, but they are not the same, the concept is similar, but the syntax and the usages are different.

## What is Commit Teller?

- Have you ever wondered about, when you opened an issue or a pull request in an open source project on GitHub, what could be story behind this issue or pull request? If it was a feature request issue/ticket, why did the author asked for it or if it was a pull request, what was the story of the work? - How did the author started to work on it?
- How many times did they refactor their initial concept?
- Can we utilize a tool that can create us documentation about our GitHub issues and/or pull requests (its commits and comments)?

**Commit Teller** is here to answer these questions. 

## The concept

**Commit Teller** reads your issue and pull request comments and commits after a Pull Request is being merged, and it creates a story about them that is being written to the issue or pull request. You can definitely save that story and you can commit under into your repository to make sure you can create a bigger story from that. Think about it if you could relive the story of the [Spring framework](https://spring.io/) or the story of the famous 3rd party libs you use on a daily basis to read CSV files, make database connections.

Not all open source projects are having well written documentations, and sometimes developers have to dig deeper into the source code itself to find answers, it would be great to rely on well written commits and create documentation from them.

## Core
We are living in an age of the AI tools, this app is not going to be different, it will utilize OpenAI's functionalities to make sure the stories can be built around the comments and commits for the different issues and/or pull requests.

After your pull requests gets merged a preconfigured GitHub action will be triggered, that will utilize OpenAI's capabilities to generate the story for your pull request and the tool itself will send the generated story to the pull request. 

## Outro
Yes, if you are thinking how the name came, I just thought about to use the name **Story Teller** but as developers we are making more commits on a daily basis than stories for sure.

Stay tuned for more news on the progress for **Commit Teller**.