Skip to content
This repository was archived by the owner on Mar 6, 2024. It is now read-only.

Commit 3123c88

Browse files
authored
update readme (#177)
1 parent 78e6eec commit 3123c88

File tree

4 files changed

+24
-16
lines changed

4 files changed

+24
-16
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,16 @@ request.
9393
[here](https://platform.openai.com/account/api-keys). Please add this key to
9494
your GitHub Action secrets.
9595

96+
### Models: `gpt-4` and `gpt-3.5-turbo`
97+
98+
At FluxNinja, we use `gpt-3.5-turbo` for lighter tasks such as summarizing the
99+
changes (`openai_model_light` in configuration) and `gpt-4` for more complex
100+
review and commenting tasks (`openai_model_heavy` in configuration).
101+
102+
Costs: `gpt-3.5-turbo` is dirt cheap. `gpt-4` is orders of magnitude more
103+
expensive, but the results are vastly superior. We are typically spending $50 a
104+
day for a 20 developer team with `gpt-4` based review and commenting.
105+
96106
### Prompts & Configuration
97107

98108
See: [action.yml](./action.yml)

action.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -102,10 +102,10 @@ inputs:
102102
- Complexity
103103
- Optimization
104104
105-
In general, refrain from making noisy comments such as on minor
106-
code style issues, compliments, missing documentation, etc.
107-
unless explicitly requested and keep the focus on substantive issues
108-
that can improve the quality of the code.
105+
Refrain from addressing minor code style issues, compliments, or missing
106+
comments/documentation, unless explicitly requested. Concentrate on
107+
identifying and resolving significant concerns to improve overall code
108+
quality while deliberately disregarding minor issues.
109109
summarize_file_diff:
110110
required: false
111111
description: 'The prompt for file'

dist/index.js

Lines changed: 5 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/review.ts

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -415,13 +415,12 @@ Important instructions:
415415
chain when reviewing the new hunk.
416416
- Use Markdown format for review comment text.
417417
- Fenced code blocks must be used for new content and replacement
418-
code/text snippets.
419-
- If you have a suggestion for replacing the code between the specified
420-
line number range, please include it in a fenced code block with the
421-
\`suggestion\` as the language identifier. The line number range
418+
code/text snippets.
419+
- If needed, provide a replacement suggestion using fenced code blocks
420+
with the \`suggestion\` as the language identifier. The line number range
422421
in the review section must map exactly to the line number range (inclusive)
423-
that need to be replaced within a new_hunk_for_review. For instance, if 2
424-
lines of code in a hunk need to be replaced with 15 lines
422+
that need to be replaced within a new_hunk_for_review.
423+
For instance, if 2 lines of code in a hunk need to be replaced with 15 lines
425424
of code, the line number range must be those exact 2 lines. If an entire hunk
426425
need to be replaced with new code, then the line number range must be the
427426
entire hunk. Replacement suggestions should be complete units that can be

0 commit comments

Comments
 (0)