Skip to content

Commit

Permalink
feat: Add information about AI commit message generation and usage of…
Browse files Browse the repository at this point in the history
… OpenAI's API in GitButler
  • Loading branch information
krlvi committed Feb 15, 2024
1 parent 167b0b5 commit 99c2c44
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 4 deletions.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,14 @@ You can find our end user documentation at: https://docs.gitbutler.com
If you have a bug or feature request, feel free to open an [issue](https://github.com/gitbutlerapp/gitbutler/issues/new),
or [join our Discord server](https://discord.gg/wDKZCPEjXC).

## AI Commit Message generation

Commit message generation is an opt-in feature. You can enable it while adding your repository for the first time or later in the project settings.

Currently GitButler uses OpenAI's API for diff summarization, which means that if enabled, code diffs would be sent to OpenAI's servers.

Our goal is to make this feature more modular such that in the future you can modify the prompt as well as plug a different LLM endpoints (including a local ones).

## Contributing

So you want to help out? Please check out the [CONTRIBUTING.md](CONTRIBUTING.md)
Expand All @@ -124,4 +132,4 @@ Want to show your support? Add a GitButler badge to your project's README:
[![GitButler](https://img.shields.io/badge/GitButler-%23B9F4F2?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB3aWR0aD0iMzkiIGhlaWdodD0iMjgiIHZpZXdCb3g9IjAgMCAzOSAyOCIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KPHBhdGggZD0iTTI1LjIxNDUgMTIuMTk5N0wyLjg3MTA3IDEuMzg5MTJDMS41NDI5NSAwLjc0NjUzMiAwIDEuNzE0MDYgMCAzLjE4OTQ3VjI0LjgxMDVDMCAyNi4yODU5IDEuNTQyOTUgMjcuMjUzNSAyLjg3MTA3IDI2LjYxMDlMMjUuMjE0NSAxNS44MDAzQzI2LjcxOTcgMTUuMDcyMSAyNi43MTk3IDEyLjkyNzkgMjUuMjE0NSAxMi4xOTk3WiIgZmlsbD0iYmxhY2siLz4KPHBhdGggZD0iTTEzLjc4NTUgMTIuMTk5N0wzNi4xMjg5IDEuMzg5MTJDMzcuNDU3MSAwLjc0NjUzMiAzOSAxLjcxNDA2IDM5IDMuMTg5NDdWMjQuODEwNUMzOSAyNi4yODU5IDM3LjQ1NzEgMjcuMjUzNSAzNi4xMjg5IDI2LjYxMDlMMTMuNzg1NSAxNS44MDAzQzEyLjI4MDMgMTUuMDcyMSAxMi4yODAzIDEyLjkyNzkgMTMuNzg1NSAxMi4xOTk3WiIgZmlsbD0idXJsKCNwYWludDBfcmFkaWFsXzMxMF8xMjkpIi8%2BCjxkZWZzPgo8cmFkaWFsR3JhZGllbnQgaWQ9InBhaW50MF9yYWRpYWxfMzEwXzEyOSIgY3g9IjAiIGN5PSIwIiByPSIxIiBncmFkaWVudFVuaXRzPSJ1c2VyU3BhY2VPblVzZSIgZ3JhZGllbnRUcmFuc2Zvcm09InRyYW5zbGF0ZSgxNi41NzAxIDE0KSBzY2FsZSgxOS44NjQxIDE5LjgzODMpIj4KPHN0b3Agb2Zmc2V0PSIwLjMwMTA1NiIgc3RvcC1vcGFjaXR5PSIwIi8%2BCjxzdG9wIG9mZnNldD0iMSIvPgo8L3JhZGlhbEdyYWRpZW50Pgo8L2RlZnM%2BCjwvc3ZnPgo%3D
)](https://gitbutler.com/)
```
[![BADGE][s6]][l6]
[![BADGE][s6]][l6]
6 changes: 5 additions & 1 deletion gitbutler-ui/src/lib/components/CloudForm.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
<div
class="flex flex-row items-center justify-between rounded-lg border border-light-400 p-2 dark:border-dark-500"
>
<div class="flex flex-row space-x-3">
<div class="flex flex-col space-x-3">
<div class="flex flex-row items-center gap-x-1">
<Checkbox
name="sync"
Expand All @@ -70,6 +70,10 @@
/>
<label class="ml-2" for="sync">Enable branch and commit message generation.</label>
</div>
<div class="pl-4 pr-8 text-sm text-light-700 dark:text-dark-200">
Uses OpenAI's API. If enabled, diffs will sent to OpenAI's servers when pressing the
"Generate message" button.
</div>
</div>
</div>
{#if user.role === 'admin'}
Expand Down
4 changes: 2 additions & 2 deletions gitbutler-ui/src/lib/components/ProjectSetup.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -96,10 +96,10 @@
<svelte:fragment slot="body">
{#if $user$}
<label class="project-setup__toggle-label" for="aiGenEnabled"
>Enable automatic branch and commit message generation.</label
>Enable automatic branch and commit message generation (uses OpenAI's API).</label
>
{:else}
Enable automatic branch and commit message generation.
Enable automatic branch and commit message generation (uses OpenAI's API).
{/if}
</svelte:fragment>
<svelte:fragment slot="toggle">
Expand Down

0 comments on commit 99c2c44

Please sign in to comment.