-
Notifications
You must be signed in to change notification settings - Fork 53
chungus LLM policy #150
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
mateuszsrebrny-reef
wants to merge
7
commits into
master
Choose a base branch
from
mateusz/llm-quality
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+67
−1
Open
chungus LLM policy #150
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
6f66bfb
RTS-234 chungus LLM policy
mateuszsrebrny-reef 56b8ae9
line breaking
mateuszsrebrny-reef b012502
review fixes
mateuszsrebrny-reef 95cdd39
Merge branch 'master' into mateusz/llm-quality
mateuszsrebrny-reef 9ee1f11
relaxing prompt saving (and smaller review comments applied)
mateuszsrebrny-reef 9b7c833
note in the code or accompanying md file as agreed on s3
mateuszsrebrny-reef fc1a545
more precise one-shot definition
mateuszsrebrny-reef File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -166,6 +166,51 @@ That's one of the reasons we have someone in that role for every project. | |
| This also allows for other solutions such as, for example, splitting the cost of a fix between two clients, discounts etc - something you couldn't do on your own. | ||
| Fortunately, with a dedicated client contact person, you don't have to! | ||
|
|
||
| ## LLM-Assisted Coding | ||
|
|
||
| Motivation | ||
|
|
||
| - LLMs let us move faster (including during reviews), but cumulative low-quality changes can erode long-term | ||
| maintainability — one of our trademarks. | ||
| - Responsibility remains human: both the author and the reviewer own the quality of what ships, regardless of tooling. | ||
| - We may intentionally accept slightly lower quality for one‑shot, low‑risk changes to gain speed, but we do so when it is | ||
| clearly safe and we document the prompt/spec. | ||
| - There’s a trade‑off: more features with less quality vs fewer features with higher quality. Over time, lower quality | ||
| makes teams ship fewer features due to maintenance drag; we optimize for sustained maintainability while using | ||
| one‑shots to keep speed where risk is minimal. | ||
| - Practical observation: there’s a limit to how much an LLM can safely rewrite in a day without agreed QA. | ||
|
|
||
| Scope and rules | ||
|
|
||
| - Default path: normal QA and review. One‑shot changes (small, independently judgeable changes) may be merged with | ||
| relaxed quality and may skip review if all of the following hold: | ||
| - The change is low‑risk, contained, and has minimal blast radius. | ||
| - The author performs a basic functional check. | ||
| - The “final prompt/spec” is saved in the repo as markdown (distilled ask + key constraints/acceptance criteria; the | ||
| chat can be condensed to a short summary) and kept up to date when the code changes. | ||
| - The one‑shot relaxation is mentioned explicitly in the PR/commit. | ||
| - The change is kept standalone (not tucked into a larger PR). | ||
| - Larger/core contributions done with LLM assistance require a case‑by‑case, agreed QA/release plan. If we must merge a | ||
| larger LLM change before full QA, do it consciously with that plan in place. Do not merge low‑quality core code | ||
| without such agreement. | ||
| - Use case‑by‑case judgement for one‑shots; if uncertain, take the normal QA/review path. | ||
|
|
||
| Author responsibilities | ||
|
|
||
| - Read every byte of generated code, functionally test it, and prepare the change for regular review (structure the diff, | ||
| write tests/docs where applicable). | ||
| - When using the one‑shot relaxation, save the prompt/spec near the change (even if you refactored the generated code). | ||
| For LLM‑assisted work that goes through normal QA/review, keeping a prompt/spec is optional. Do not include secrets or | ||
| client‑sensitive data in prompts. | ||
|
||
|
|
||
| Review expectations | ||
|
|
||
| - Normal review applies; the reviewer may use or not use LLM tooling. | ||
| - If a one‑shot change is being reviewed anyway, verify that the prompt/spec exists, is up to date, and meaningfully | ||
| reflects the change. | ||
| - Confirm maintainability isn’t degraded (structure, naming, tests, docs), and that no secrets are stored in | ||
| prompts/specs. | ||
|
|
||
| ## Fast track decisions via Slack instead of standard Sociocracy approach | ||
|
|
||
| At Reef Technologies, we mostly make decisions in our weekly Sociocracy meetings. | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I find this requirement "stupid" ;) - most of my prompts are:
[20 lines of logs with bug]
you see you f***ed up, fix it you ******** :D
I think it might be helpful to instruct LLM to take context and summarize it as a "development log" - or maybe put some additional info about why this decision was made that code is not able to give
but really - most of the time instead of explaining what to be done... or has been done... I like say:
read this commit diff
...
now we need to add...
even when I need to cleat context I just bootstrap next with diff - it has the most information inside...
AND...
if we REALLY want some insights from context be visible in repo - the best thing is to instruct to write it in comments... why? - because those are really close to the code and when you work with LLM on the code in new context you don't need instruct it to find documents that might have up to date info about it... - if LLM has this info close to the code it will update it when it will be asked to change something....
really... most of docs are now generated from code - because it is the most natural way to store it :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I share some of @mzukowski-reef concerns. What exactly is the intention behind this saving spec requirement? Maybe it should be mentioned in the handbook.
There also lacks a practical example of how the prompt should be saved. Like, we all have different styles of vibe coding. Am I to save only the main prompt and omit the other minor ones? Or maybe I should prompt llm to prepare the session summary? Where should it be placed?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mzukowski-reef @kacper-wolkiewicz-reef -> you are right, I have relaxed the prompt saving requirements. If you agree I will bring it back to s3 tomorrow for final vote :)