Skip to content

Conversation

@mateuszsrebrny-reef
Copy link
Contributor

In this PR:

  • policy of one-shotting small and separated pieces of the code is introduced
  • it is made clear that besides ^^ we don't trade off the maintainability and quality of our software

agreements.md Outdated
Comment on lines 188 to 189
- The final “prompt/spec” is saved in the repository as markdown and kept up to date when the code changes.
- The conversation history may be condensed into a short “final prompt/summary” rather than stored verbatim.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't quite understand this guide. What does it mean "final" promt, does it mean I should save only the last promt I input into LLM? What is a purpose of this?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

relaxed the thing, I hope you will like it :)

agreements.md Outdated
Comment on lines 200 to 201
- Include a link to the prompt/spec in the PR or commit description. Do not include secrets or client‑sensitive data in
prompts.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is unclear to me - should I link to the prompt every time I use llm in my PR even if I review and refactor it? Why?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good catch, no, it is not needed, I relaxed the requirement of saving the prompt

@mateuszsrebrny-reef
Copy link
Contributor Author

@kacper-wolkiewicz-reef would you care to check out my fixes 🙏 ? Is the thing more clear now?

agreements.md Outdated
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
Copy link
Contributor

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 :)

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?

Copy link
Contributor Author

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 :)

Copy link

@kacper-wolkiewicz-reef kacper-wolkiewicz-reef left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Most of my issues are resolved, but I still don't quite understand the idea behind this prompt saving and how it should be done. I would be very grateful to add the information:

  1. What is the idea behind prompt saving. There is a small mention that "so future bugs can be fixed smoothly." but like, how saving the prompt will help with it?
  2. An example of the properly saved prompt could be helpful.

Otherwise very well structured document 👍

agreements.md Outdated
Comment on lines 203 to 204
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.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do not include secrets or client‑sensitive data in prompts.

This is probably kinda obvious, but if we are mentioning it in the handbook then I think it should be stated clearly and seperatly as a most important point of all.

agreements.md Outdated
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

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants