jhnoor/tarik-autocoder

Update README.md to include tech stack details and goal of this project

Closed this issue · 1 comments

jhnoor commented

As a developer, I would like to be able to understand what kind of tech stack this project is running on by just reading the README instead of having to dig through multiple files. The README should state that this is a .NET 7 application, using the Clean Architecture principles in order to seperate by layers, that we consume the Github API, and more importantly that we integrate with OpenAI's API in order to use GPT4.

I also want to understand why this project exists. We should write something about how developers can use Tarik to delegate small tasks. Another use case we can write about is how Tarik can bootstrap an issue for you, creating a branch and PR with some suggested changes already done, giving the reins over to a human at that point to finish it off.

tarik-tasktopr commented

Step-by-step discussion

We need to update the README.md file to include information about the tech stack and the goal of the project. This will help developers understand the project's purpose and the technologies used without having to dig through multiple files.

Plan

  1. Edit the file README.md: Add a section called "Tech Stack" to provide details about the technologies used in the project, such as .NET 7, Clean Architecture principles, Github API, and OpenAI's GPT-4 API.
  2. Edit the file README.md: Add a section called "Project Goal" to explain the purpose of the project, including how developers can use Tarik to delegate small tasks and how Tarik can bootstrap an issue, create a branch and PR with suggested changes, and hand over the work to a human to finish it off.

EDIT: Plan approved! ✅

  • 👍1