From 5fcaffdada39e908f682d4919a6ebadf01cb7c22 Mon Sep 17 00:00:00 2001 From: octoshrimpy Date: Sat, 1 Aug 2026 13:59:26 -0400 Subject: [PATCH] docs(contributing): give DeepWiki its own section with badge The link was buried at the end of "Getting Your Pull Request Merged", a section about PR etiquette rather than reading code. Move it under its own heading at the top of Helpful Tips, where someone about to explore the codebase will actually look, and add the badge to match the README. --- CONTRIBUTING.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ab011219..5dc9bdef 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -64,12 +64,15 @@ To update the wiki, simply navigate to the [wiki tab](https://github.com/octoshr ## Helpful Tips +### Understand the Codebase +[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/octoshrimpy/quik) + +Feel free to use [deepwiki LLM](https://deepwiki.com/octoshrimpy/quik) to understand the code structure before contributing and explore the implementation interactively. + ### Getting Your Pull Request Merged When submitting a pull request, please be as detailed as possible in your reasoning for the change, what you changed and how you tested it. \ In addition, please try to keep pull requests atomic and singularly focused. Submitting large pull requests that have multiple changes or touch multiple code paths are much more difficult to review and may be asked to be split apart. -Feel free to use [deepwiki LLM](https://deepwiki.com/octoshrimpy/quik) to understand the code structure before contributing and explore the implementation interactively. - ### Open Draft Pull Requests If you are stuck or in the middle of a larger code change, open up a draft pull request. That way you can receive help and suggestions while you are developing. \ If you are stuck on something specific open up that draft PR, or hop on over to [matrix](https://matrix.to/#/#quik-sms:matrix.org) for suggestions.