Skip to content

docs: DESIGN_GUIDE.md#794

Open
zkraus wants to merge 4 commits intoKuadrant:mainfrom
zkraus:design_guide
Open

docs: DESIGN_GUIDE.md#794
zkraus wants to merge 4 commits intoKuadrant:mainfrom
zkraus:design_guide

Conversation

@zkraus
Copy link
Copy Markdown
Contributor

@zkraus zkraus commented Oct 16, 2025

This is a team wide open PR, please do suggest addition, edits, anything that you thing might be useful for this guide.

Design guide is suppose to be a set of guidelines and tips on how to design tests, write commits, submit a review PRs, and anything that might be useful.

Copy link
Copy Markdown
Contributor

@averevki averevki left a comment

Choose a reason for hiding this comment

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

Maybe something we can convert to project's claude.md context file down the road. LGTM now 👍

Copy link
Copy Markdown
Contributor

@averevki averevki left a comment

Choose a reason for hiding this comment

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

@zkraus sign-off the commit when you're done please. CI won't allow PR to merge without it

Copy link
Copy Markdown
Contributor

@averevki averevki left a comment

Choose a reason for hiding this comment

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

^

Copy link
Copy Markdown
Contributor

@emmaaroche emmaaroche left a comment

Choose a reason for hiding this comment

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

Left a few small suggestions to add to the Commits and Creating PRs sections, feel free to apply, modify, or decline them as you see fit 😄

Comment thread DESIGN_GUIDE.md Outdated
Comment thread DESIGN_GUIDE.md
Copy link
Copy Markdown
Member

@azgabur azgabur left a comment

Choose a reason for hiding this comment

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

Want to review/collaborate before merge, just need to find time

@averevki
Copy link
Copy Markdown
Contributor

@zkraus @azgabur hey, are you still working on this PR?

@zkraus
Copy link
Copy Markdown
Contributor Author

zkraus commented Apr 8, 2026

@averevki I am sorry, this slipped off my radar due to other priorities, and as you mentioned, it might not be relevant anymore, are we defining the workflows for Claude. Do you think it's still worth having this? Should you pick it back up, and continue?

@averevki
Copy link
Copy Markdown
Contributor

averevki commented Apr 8, 2026

I'm actually fine with also having a smaller design guide for a human eye read. Should we use CLAUDE.md only for processing by AI? This way we could keep CLAUDE.md large and don't care about readability in there much.

I know @azgabur had an opinion about testsuite designing doc, would be great to get his thoughts on this

@azgabur
Copy link
Copy Markdown
Member

azgabur commented Apr 8, 2026

Indeed I cant find time to properly put my thoughts in a document about how the changes to the testsuite should be made. But I can see the Claude.md already has some pointers. Human is just an another AI (but just I) so maybe the work could be merged in one file.

@zkraus
Copy link
Copy Markdown
Contributor Author

zkraus commented Apr 13, 2026

I think, it would be smarter to have a human readable summary written down. And have CLAUDE.md or any other claude specific md file optimized for Claude. Even though that would mean we need to keep them all in sync.

Let me try to distill the essence of it from CLAUDE.md and we can review the result.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 13, 2026

Warning

Rate limit exceeded

@zkraus has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 36 minutes and 46 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 36 minutes and 46 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: a8e90117-75bd-49ae-9711-57719a8241ed

📥 Commits

Reviewing files that changed from the base of the PR and between 41162ab and da37669.

📒 Files selected for processing (1)
  • DESIGN_GUIDE.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@zkraus
Copy link
Copy Markdown
Contributor Author

zkraus commented Apr 13, 2026

Rebased to main (not latest, need to do another one 🤦 ), and updated DESIGN_DOCS from CLAUDE.md

zkraus and others added 4 commits April 13, 2026 16:00
Design guide is suppose to be a set of guidelines and tips on how to
desing tests, write commits, submit a review PRs, and anything that
might be usefull.
Co-authored-by: Emma Roche <eroche@redhat.com>
Co-authored-by: Emma Roche <eroche@redhat.com>
rules are written and up to date.

Signed-off-by: Zdenek Kraus <zkraus@redhat.com>
@zkraus
Copy link
Copy Markdown
Contributor Author

zkraus commented Apr 13, 2026

Now it is rebase to the latest main, Sorry about that. No other code changes.

@zkraus zkraus changed the title ADD: DESIGN_GUIDE.md docs: DESIGN_GUIDE.md Apr 14, 2026
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