From d3e0e33ca94cec2f691b35bd0935ab9ad7001722 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 25 Dec 2024 22:34:07 +0000 Subject: [PATCH] docs(contributor): contributors readme action update (#160) * 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 --- README.md | 75 ++++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 71 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c92766aa..ca038444 100644 --- a/README.md +++ b/README.md @@ -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). @@ -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`. @@ -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 "." @@ -202,9 +201,77 @@ Here is a sample `debug.json` content: ### Contributors + + + + + + + + +
+ + guibranco +
+ Guilherme Branco Stracini +
+
+ + Malay-dev +
+ Malay Kumar +
+
+ + RyanFloresTT +
+ Ryan Flores +
+
### Bots + + + + + + + + + + +
+ + dependabot[bot] +
+ dependabot[bot] +
+
+ + penify-dev[bot] +
+ penify-dev[bot] +
+
+ + gitauto-ai[bot] +
+ gitauto-ai[bot] +
+
+ + snyk-bot +
+ Snyk bot +
+
+ + codefactor-io +
+ CodeFactor +
+