DEV Community

Cover image for Add this "AI Code Assist" badge to your Github Readme
Samyak Jain for CommandDash

Posted on • Updated on

Add this "AI Code Assist" badge to your Github Readme

If you are building an open-source project, there is a good chance that your readme is full of badges like this:

Image description

Badges help share the status of various aspects of your repo, it's popularity and link to helpful resources for visitors like documentation.

In the AI era, there is a badge that is missing. A badge that can help your users explore your repository 🌈 and build with it faster⚡️ without reading docs.

Introducing "AI Code Assist" Badge:

To add such badge to your repo, just add the below to your readme.

<a href="https://app.commanddash.io/agent?github=<your github repo>"><img src="https://img.shields.io/badge/AI-Code%20Gen-EB9FDA"></a>
Enter fullscreen mode Exit fullscreen mode
  • Replace <your github repo> with your Github Repository URL, for example: https://github.com/apify/crawlee-python

This will create an AI code assist trained on your code + issues in your repository.

Developers can click the badge, to access the code assist directly in a web app.
Image description

They can ask any questions are quoted with links to code and issues from your repository along with the answer.

Sounds great right? 🤩 Add it to your repo and help developers build faster!

Top comments (4)

Collapse
 
shricodev profile image
Shrijal Acharya

Why did this great tip take so long to reach my feed? 👀

Collapse
 
samyakkkk profile image
Samyak Jain

good things come at right times :) hope you find the badge helpful.

Collapse
 
dreama profile image
Dream

This sounds like a fantastic addition to any readme! How well does the AI handle complex or poorly-documented code?

Collapse
 
samyakkkk profile image
Samyak Jain

Most models including ours can make sense of undocumented or complex code fairly well.

However, code comments are helpful when they share any insights or facts that aren't apparent looking at the code itself.