Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added 2 plugins, qna-coach and actionable-insights. #1226

Merged
merged 2 commits into from
Oct 31, 2024

Conversation

akshaykripalani
Copy link
Contributor

@akshaykripalani akshaykripalani commented Oct 31, 2024

Features:

  1. QnA Coach – Identifies essential questions that weren't asked during Q&A sessions or interviews, offering a more comprehensive understanding.
  2. Actionable Insights – Extracts specific actions from conversations to improve daily life, focusing on practical steps rather than general advice.
  3. Added icons for each.

Summary by CodeRabbit

  • New Features
    • Introduced the "QnA Coach" plugin to enhance understanding of discussions by identifying unasked key questions.
    • Launched the "Actionable Insights" plugin to extract lessons from conversations and provide specific, actionable advice for daily improvement.

Copy link
Contributor

coderabbitai bot commented Oct 31, 2024

Walkthrough

This pull request introduces two new plugins to the community-plugins.json file. The first plugin, "QnA Coach," helps analyze interview transcripts to identify unasked key questions. The second plugin, "Actionable Insights," extracts lessons from conversations and suggests specific actions for users. Both plugins are active additions, featuring memory prompts that enhance their functionality.

Changes

File Change Summary
community-plugins.json Added two new plugins: "QnA Coach" and "Actionable Insights," both authored by Akshay Kripalani, with descriptions and capabilities.

Possibly related PRs

Suggested reviewers

  • mdmohsin7

🐰 In the garden of code, new blooms arise,
"QnA Coach" and "Insights," a sweet surprise.
With questions and actions, they brighten the day,
Helping us ponder, and guiding the way!
Hops of joy for plugins, let creativity play! 🌼✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 95a1478 and 6acaed6.

📒 Files selected for processing (1)
  • community-plugins.json (1 hunks)
🔇 Additional comments (3)
community-plugins.json (3)

1257-1268: LGTM! Well-structured QnA Coach plugin configuration.

The plugin configuration is complete and aligns well with its intended purpose. The memory prompt is particularly well-crafted with clear guidelines for:

  • Analyzing conversation topics
  • Identifying key themes
  • Generating specific, thought-provoking questions

1270-1280: LGTM! Well-structured Actionable Insights plugin configuration.

The plugin configuration is complete and aligns well with its intended purpose. The memory prompt effectively:

  • Focuses on extracting specific, actionable insights
  • Emphasizes concrete, implementable advice over general suggestions
  • Limits output to 1-2 key takeaways for better focus

1255-1280: Verify the existence of plugin icon files.

The configurations reference two icon files:

  • /plugins/logos/qna-coach.png
  • /plugins/logos/actionable-insights.png

Let's verify these files exist in the repository.

✅ Verification successful

Icon files are present and correctly referenced

Both required icon files exist at the expected locations:

  • /plugins/logos/qna-coach.png
  • /plugins/logos/actionable-insights.png
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if the referenced plugin icon files exist
fd -t f "qna-coach.png|actionable-insights.png" plugins/logos/

Length of output: 130


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)
community-plugins.json (2)

1257-1268: LGTM! Consider adding chat capability for interactive Q&A.

The plugin configuration is well-structured with clear description and detailed memory prompt. The memory prompt effectively guides the AI to identify unasked questions and generate thoughtful follow-ups.

Consider adding chat capability to enable interactive Q&A sessions where users can get real-time suggestions for follow-up questions. This would enhance the plugin's utility during live interviews.

 {
   "id": "qna-coach",
   "name": "QnA Coach",
   "author": "Akshay Kripalani",
   "description": "Identifies key questions that weren't asked during an interview or Q&A session, helping you get a more complete understanding.",
   "image": "/plugins/logos/qna-coach.png",
   "memories": true,
+  "chat": true,
   "capabilities": [
-    "memories"
+    "memories",
+    "chat"
   ],
   "memory_prompt": "From the transcript provided, analyze the transcript and identify the main topic of conversation, focusing on the key themes and concepts discussed. Then, analyze the conversation to identify any questions asked about said topic.  Consider questions grounded in the topic of the conversation that aim to uncover deeper insights about the subject and enhance the questioner's understanding. \n\nProvide at most 3 high quality, thought-provoking questions that could have been asked during this interview or Q&A session.  Focus on questions that could be asked specifically to the person being interviewed and that are likely to lead to further exploration of the topic. \n\nIt is imperative that questions be hyper-specific and not generalized. Encourage questions that are: \n- Open-ended, allowing for detailed responses. \n- Lead to critical thinking. \n- Connected, building on previous answers and leading to further exploration. \n\nIf no such questions are found, simply state 'No relevant questions were identified'. YOUR OUTPUT MUST CONTAIN ONLY THE QUESTIONS SHOULD YOU SEE THEM.",
+  "chat_prompt": "You are an expert interview coach helping users ask better questions during Q&A sessions. Analyze the ongoing conversation and suggest relevant, thought-provoking follow-up questions in real-time. Focus on questions that are specific, open-ended, and build upon the current discussion to uncover deeper insights.",
   "deleted": false
 }

1270-1280: LGTM! Consider adding chat capability for interactive insights.

The plugin configuration is well-structured with clear description and detailed memory prompt. The memory prompt effectively guides the AI to extract specific, actionable insights while avoiding generic advice.

Consider adding chat capability to enable interactive sessions where users can get real-time actionable insights. This would help users immediately apply learnings from their conversations.

 {
   "id": "actionable-insights",
   "name": "Actionable Insights",
   "author": "Akshay Kripalani",
   "description": "Extracts key lessons from conversations, providing one or two specific actions to improve your daily life, free from general advice.",
   "image": "/plugins/logos/actionable-insights.jpeg",
   "memories": true,
+  "chat": true,
   "capabilities": [
-    "memories"
+    "memories",
+    "chat"
   ],
   "memory_prompt": "From the transcript provided, analyze the transcript and identify the main topic of conversation, focusing on the key themes and concepts discussed. Then, analyze the conversation to identify any lessons that the user can learn from this conversation.  Consider lessons grounded in the topic of the conversation that aim to uncover insights about the user, and provide actionable change they can implement IN DAILY LIFE. Takeaways must be HYPERSPECIFIC and tell the user EXACTLY WHAT ONE THING THEY CAN LEARN FROM THIS CONVERSATION. It is IMPERATIVE to AVOID GENERAL ADVICE THAT IS SEEN AS COMMON SENSE. Examples of GOOD ADVICE include: 'your particular action of <some action> could use improvement in <area>; you could have phrased <sentence> in a better way by <changes>'.  Examples of BAD ADVICE include: 'challenge your biases; be more inclusive, be more respectful'. Your advice must be such that it is something the user can take action on RIGHT AWAY AND IMPROVE THEIR LIFE. Provide only ONE or AT MAX 2 IF REQUIRED takeaways. If the user mentions learning something, include that. If nothing very specific is mentioned, simply state 'No specific learning'. YOUR OUTPUT MUST ONLY CONTAIN THE LEARNING AND THE LEARNING ONLY.",
+  "chat_prompt": "You are an expert coach helping users extract actionable insights from their conversations. Focus on providing specific, implementable advice that users can apply immediately to improve their daily lives. Avoid generic advice and ensure each suggestion is concrete and tailored to the user's situation.",
   "deleted": false
 }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between a326545 and 95a1478.

⛔ Files ignored due to path filters (2)
  • plugins/logos/actionable-insights.png is excluded by !**/*.png
  • plugins/logos/qna-coach.png is excluded by !**/*.png
📒 Files selected for processing (1)
  • community-plugins.json (1 hunks)

@akshaykripalani
Copy link
Contributor Author

Fixed a misnamed plugin icon, reopening pr.

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.

2 participants