Skip to content

Commit

Permalink
docs(contributor): contributors readme action update (#160)
Browse files Browse the repository at this point in the history
* docs(contributor): contrib-readme-action has updated readme

* Update README.md

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Guilherme Branco Stracini <[email protected]>
  • Loading branch information
github-actions[bot] and guibranco authored Dec 25, 2024
1 parent f535db8 commit d3e0e33
Showing 1 changed file with 71 additions and 4 deletions.
75 changes: 71 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,6 @@

---

> [!CAUTION]
> This is still in development/beta. It will be **GA** when a major release 1.0 becomes available.
## What this tool does

Generates a commit message based on the `git diff` result using the [OpenAI API](https://platform.openai.com/docs/overview).
Expand Down Expand Up @@ -81,6 +78,8 @@ dotnet-aicommitmessage set-settings -m llama-3-1-405b-instruct

This allows for quick model changes while retaining your previously configured API details.

---

#### Supported Models

Currently supported models are `gpt-4o-mini` and `llama-3-1-405b-instruct`.
Expand Down Expand Up @@ -152,7 +151,7 @@ dotnet-aicommitmessage generate-message -m "."

### Saving the OpenAI JSON response

If you want to persist the OpenAI JSON response, add the `-D` parameter and a `debug.json` file will be created with the response JSON.
If you want to persist the OpenAI JSON response, add the `-D` parameter, and a `debug.json` file will be created with the response JSON.

```ps
dotnet-aicommitmessage generate-message -Dm "."
Expand Down Expand Up @@ -202,9 +201,77 @@ Here is a sample `debug.json` content:
### Contributors

<!-- readme: collaborators,contributors,snyk-bot/-,guistracini-outsurance-ie/-,codefactor-io/- -start -->
<table>
<tbody>
<tr>
<td align="center">
<a href="https://github.com/guibranco">
<img src="https://avatars.githubusercontent.com/u/3362854?v=4" width="100;" alt="guibranco"/>
<br />
<sub><b>Guilherme Branco Stracini</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/Malay-dev">
<img src="https://avatars.githubusercontent.com/u/91375797?v=4" width="100;" alt="Malay-dev"/>
<br />
<sub><b>Malay Kumar</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/RyanFloresTT">
<img src="https://avatars.githubusercontent.com/u/53247675?v=4" width="100;" alt="RyanFloresTT"/>
<br />
<sub><b>Ryan Flores</b></sub>
</a>
</td>
</tr>
<tbody>
</table>
<!-- readme: collaborators,contributors,snyk-bot/-,guistracini-outsurance-ie/-,codefactor-io/- -end -->

### Bots

<!-- readme: bots,snyk-bot,codefactor-io -start -->
<table>
<tbody>
<tr>
<td align="center">
<a href="https://github.com/dependabot[bot]">
<img src="https://avatars.githubusercontent.com/in/29110?v=4" width="100;" alt="dependabot[bot]"/>
<br />
<sub><b>dependabot[bot]</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/penify-dev[bot]">
<img src="https://avatars.githubusercontent.com/in/399279?v=4" width="100;" alt="penify-dev[bot]"/>
<br />
<sub><b>penify-dev[bot]</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/gitauto-ai[bot]">
<img src="https://avatars.githubusercontent.com/in/844909?v=4" width="100;" alt="gitauto-ai[bot]"/>
<br />
<sub><b>gitauto-ai[bot]</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/snyk-bot">
<img src="https://avatars.githubusercontent.com/u/19733683?v=4" width="100;" alt="snyk-bot"/>
<br />
<sub><b>Snyk bot</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/codefactor-io">
<img src="https://avatars.githubusercontent.com/u/11671095?v=4" width="100;" alt="codefactor-io"/>
<br />
<sub><b>CodeFactor</b></sub>
</a>
</td>
</tr>
<tbody>
</table>
<!-- readme: bots,snyk-bot,codefactor-io -end -->

0 comments on commit d3e0e33

Please sign in to comment.