https://github.com/quack-ai/companion Skip to content Toggle navigation Sign in * Product + Actions Automate any workflow + Packages Host and manage packages + Security Find and fix vulnerabilities + Codespaces Instant dev environments + Copilot Write better code with AI + Code review Manage code changes + Issues Plan and track work + Discussions Collaborate outside of code Explore + All features + Documentation + GitHub Skills + Blog * Solutions For + Enterprise + Teams + Startups + Education By Solution + CI/CD & Automation + DevOps + DevSecOps Resources + Learning Pathways + White papers, Ebooks, Webinars + Customer Stories + Partners * Open Source + GitHub Sponsors Fund open source developers + The ReadME Project GitHub community articles Repositories + Topics + Trending + Collections * Pricing Search or jump to... Search code, repositories, users, issues, pull requests... Search [ ] Clear Search syntax tips Provide feedback We read every piece of feedback, and take your input very seriously. [ ] [ ] Include my email address so I can be contacted Cancel Submit feedback Saved searches Use saved searches to filter your results more quickly Name [ ] Query [ ] To see all available qualifiers, see our documentation. Cancel Create saved search Sign in Sign up You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert {{ message }} quack-ai / companion Public * Notifications * Fork 4 * Star 116 IDE extension for contribution assistance docs.quackai.com License Apache-2.0 license 116 stars 4 forks Activity Star Notifications * Code * Issues 3 * Pull requests 0 * Discussions * Actions * Projects 0 * Security * Insights Additional navigation options * Code * Issues * Pull requests * Discussions * Actions * Projects * Security * Insights quack-ai/companion This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository. main Switch branches/tags [ ] Branches Tags Could not load branches Nothing to show {{ refName }} default View all branches Could not load tags Nothing to show {{ refName }} default View all tags Name already in use A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch? Cancel Create 1 branch 0 tags Code * Local * Codespaces * Clone HTTPS GitHub CLI [https://github.com/q] Use Git or checkout with SVN using the web URL. [gh repo clone quack-] Work fast with our official CLI. Learn more about the CLI. * Open with GitHub Desktop * Download ZIP Sign In Required Please sign in to use Codespaces. Launching GitHub Desktop If nothing happens, download GitHub Desktop and try again. Launching GitHub Desktop If nothing happens, download GitHub Desktop and try again. Launching Xcode If nothing happens, download Xcode and try again. Launching Visual Studio Code Your codespace will open once ready. There was a problem preparing your codespace, please try again. Latest commit @frgfm frgfm docs: Updates README and CONTRIBUTING (#29) ... 77281d8 Dec 18, 2023 docs: Updates README and CONTRIBUTING (#29) * chore: Bumps version index * docs: Updates Changelog * docs: Updates contributing * docs: Updates README 77281d8 Git stats * 26 commits Files Permalink Failed to load latest commit information. Type Name Latest commit message Commit time .github refactor: Reorganizes commands for easier maintenance & improved clar... December 15, 2023 19:28 .vscode feat: Adds authentication command for API interactions (#11) October 31, 2023 14:53 media [ImgBot] Optimize images (#22) December 13, 2023 22:06 src refactor: Reorganizes commands for easier maintenance & improved clar... December 15, 2023 19:28 .eslintrc.json feat: Adds basic extension for guideline compliance & contribution sc... August 7, 2023 05:19 .gitignore feat: Adds basic extension for guideline compliance & contribution sc... August 7, 2023 05:19 .vscodeignore feat: Adds basic extension for guideline compliance & contribution sc... August 7, 2023 05:19 .yarnrc feat: Adds basic extension for guideline compliance & contribution sc... August 7, 2023 05:19 CHANGELOG.md docs: Updates README and CONTRIBUTING (#29) December 18, 2023 17:03 CODE_OF_CONDUCT.md feat: Adds basic extension for guideline compliance & contribution sc... August 7, 2023 05:19 CONTRIBUTING.md docs: Updates README and CONTRIBUTING (#29) December 18, 2023 17:03 LICENSE Initial commit August 6, 2023 23:51 Makefile feat: Adds basic extension for guideline compliance & contribution sc... August 7, 2023 05:19 README.md docs: Updates README and CONTRIBUTING (#29) December 18, 2023 17:03 package.json docs: Updates README and CONTRIBUTING (#29) December 18, 2023 17:03 tsconfig.json refactor: Removes svelte & rollup (#10) September 30, 2023 15:18 webpack.config.js feat: Adds basic extension for guideline compliance & contribution sc... August 7, 2023 05:19 yarn.lock refactor: Reorganizes commands for easier maintenance & improved clar... December 15, 2023 19:28 View code [ ] Quack Companion Quick Tour Contribution guidance Walthrough tutorial Setup Prerequisites Install the extension Roadmap Telemetry Why we collect information What we collect What you can do about it Copying & distribution Contributing README.md [68747470733a2] Quack Companion VSCode extension Backend API Frontend dashboard Documentation CI Status eslint prettier codacy VS Marketplace Open VSX Registry Node.js license [6874747073] Twitter Compliance hint This extension guides you through your code contributions with Quack as a companion. The extension provides curated contribution guidelines from maintainers and assists you in meeting them. Quick Tour Contribution guidance Guideline view Once installed, when you open a public GitHub project, the extension will give you a new tab wher you'll find: * Guidelines: automatic compliance of contribution guidelines, so that you can avoid the back-and-forth between the PR reviews and your IDE! * Code chat (coming soon) Walthrough tutorial Developer walkthrough With our walkthrough tutorial, you're only a few clicks away from having your own coding companion. Setup Prerequisites Install VSCode Install the extension Either: * Follow the instructions on the online VS Marketplace page * In VSCode, click on Extensions in the sidebar, search for "Quack Companion" and click on "Install" Roadmap The ultimate goal for this extension is to offer a smooth contribution experience for any developer. The development efforts will be focused on achieving the following milestones: * Turn contribution guidelines into a live pair coding experience (code completion & code chat) * Help any developer find a starter contribution opportunity * [?][?] Ensure alignment between the contribution goal and the project's priorities Telemetry Why we collect information Quack is dedicated to transform the contribution workflow of developers. Developer tools are among the most difficult types of product to build and we need to better understand where to allocate/ reduce our efforts over time. Since we want to keep providing free options for our services in the future, and since we don't want to rely on advertising, we humbly ask you to share limited usage data so that we can improve the products and services that we offer. What we collect For each event, here is the largest amount of data we collect: * Event identifiers: the event type (e.g.fetch-guidelines) and potentially the scope (e.g. the repository) * User information: depending on the telemetry setting, either your GitHub username or an anonymized UUID specific to you (created when you first activate the extension). And since the extension is open source, you can navigate the codebase to verify the above information if you feel like it ;) What you can do about it This data collection is done using Posthog and can be: * anonymized: by default we'll identify your actions with your GitHub username. We'll keep an option to prevent that identification, as we understand it's important for developers to have this choice. * disabled: like in most VSCode extensions, you have the ability to disable telemetry completely. Copying & distribution Copyright (C) 2023, Quack AI. This program is licensed under the Apache License 2.0. See LICENSE or go to https://www.apache.org/licenses/LICENSE-2.0 for full license details. Contributing Feeling like improving the interface? Or perhaps submitting a new feature idea? Any sort of contribution is greatly appreciated! You can find a short guide in CONTRIBUTING to help grow this project! And if you're interested, you can join us on [6874747073] About IDE extension for contribution assistance docs.quackai.com Topics developer-tools vscode-extension contribution guidelines maintainers code-assistant Resources Readme License Apache-2.0 license Code of conduct Code of conduct Security policy Security policy Activity Stars 116 stars Watchers 2 watching Forks 4 forks Report repository Releases No releases published Contributors 5 * @frgfm * @imgbot[bot] * @ImgBotApp * @dependabot[bot] * @ShivangRawat30 Languages * TypeScript 95.4% * JavaScript 4.2% * Makefile 0.4% Footer (c) 2023 GitHub, Inc. Footer navigation * Terms * Privacy * Security * Status * Docs * Contact * Manage cookies * Do not share my personal information You can't perform that action at this time.