ADD: DESIGN_GUIDE.md #794
Open
ADD: DESIGN_GUIDE.md #794
Conversation
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
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.
zkraus
requested review from
averevki,
azgabur,
crstrn13,
emmaaroche,
fabikova,
silvi-t,
tomas-jochec and
trepel
averevki
approved these changes
Oct 20, 2025
Contributor
averevki
left a comment
averevki
left a comment
There was a problem hiding this comment.
Maybe something we can convert to project's claude.md context file down the road. LGTM now 👍
emmaaroche
reviewed
Oct 20, 2025
Contributor
emmaaroche
left a comment
emmaaroche
left a comment
There was a problem hiding this comment.
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 on lines
+24
to
+26
| 1. To promote quality code, request 2 reviewers | ||
| 1. Link relevant issues, and/or summarize the changes | ||
| 1. Consider providing a verification steps in the PR description (might have a tool for that) |
Contributor
There was a problem hiding this comment.
Suggested change
| 1. To promote quality code, request 2 reviewers | |
| 1. Link relevant issues, and/or summarize the changes | |
| 1. Consider providing a verification steps in the PR description (might have a tool for that) | |
| 1. To promote quality code, request 2 reviewers | |
| 1. Link relevant issues, and/or summarize the changes | |
| 1. Consider providing a verification steps in the PR description (might have a tool for that) | |
| 1. Ensure CI checks pass before opening a PR (e.g., DCO sign-off, code analysis, GitGuardian) | |
| 1. Use a draft PR to share work in progress and gather early feedback before marking it ready for review |
|
|
||
| ## Commits | ||
|
|
||
| 1. Consider using https://www.conventionalcommits.org/en/v1.0.0/ (.gitmessage) |
Contributor
There was a problem hiding this comment.
Suggested change
| 1. Consider using https://www.conventionalcommits.org/en/v1.0.0/ (.gitmessage) | |
| 1. Consider using https://www.conventionalcommits.org/en/v1.0.0/ (.gitmessage) | |
| 1. Run `make reformat` and `make commit-acceptance` locally to catch code analysis or formatting issues before committing and pushing | |
| 1. Sign off commits by adding the `-s` flag (`git commit -s`) | |
| 1. Optionally, sign commits with the `-S` flag (`git commit -S`) if you have a GPG or SSH key configured — this verifies commit authenticity on GitHub |
azgabur
requested changes
Oct 31, 2025
Contributor
azgabur
left a comment
azgabur
left a comment
There was a problem hiding this comment.
Want to review/collaborate before merge, just need to find time
Contributor
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
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.