Adds Bob Skill for New Joinee Onboarding#1893
Open
bhanvimenghani wants to merge 1 commit into
Open
Conversation
Contributor
Reviewer's GuideAdds a new Bob onboarding skill for Kruize Autotune, consisting of structured onboarding workflow plus six detailed markdown guides covering setup, architecture, code structure, testing, first PR workflow, and API usage, all under .bob/skills/onboarding/. Sequence diagram for Bob onboarding skill activationsequenceDiagram
actor NewJoinee
actor Mentor
participant BobAI
participant BobOnboardingSkill
participant OnboardingDocs
NewJoinee->>Mentor: Ask_how_to_get_started_with_Kruize
Mentor-->>NewJoinee: Suggest_using_Bob_for_onboarding
NewJoinee->>BobAI: Help_me_onboard_a_new_team_member
BobAI->>BobOnboardingSkill: Match_intent_onboarding_request
BobOnboardingSkill-->>BobAI: Load_SKILL_md_and_supporting_docs
BobAI-->>NewJoinee: Present_onboarding_phases_and_next_step
loop Guided_onboarding_phases
NewJoinee->>BobAI: Request_next_step_details
BobAI->>BobOnboardingSkill: Fetch_step_context_and_targets
BobOnboardingSkill->>OnboardingDocs: Retrieve_relevant_md_file
OnboardingDocs-->>BobOnboardingSkill: Return_section_content
BobOnboardingSkill-->>BobAI: Compose_step_specific_instructions
BobAI-->>NewJoinee: Explain_actions_and_link_docs
end
Flow diagram for onboarding documentation pathflowchart TD
start["Start_onboarding<br/>(SKILL_md)"]
start --> setup_checklist
setup_checklist["setup_checklist_md<br/>Environment_setup"]
setup_checklist --> arch_overview
arch_overview["architecture_overview_md<br/>High_level_architecture"]
arch_overview --> code_structure
code_structure["code_structure_md<br/>Java_packages_and_modules"]
code_structure --> testing_guide
testing_guide["testing_guide_md<br/>Pytest_and_Maven_tests"]
testing_guide --> api_quick_ref
api_quick_ref["api_quick_reference_md<br/>Core_API_calls"]
api_quick_ref --> first_pr
first_pr["first_pr_guide_md<br/>PR_workflow_and_GPG_commits"]
first_pr --> complete
complete["Ready_for_assigned_task<br/>(Onboarding_complete)"]
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- The new onboarding docs re-describe a lot of existing workflows (e.g., tests, APIs, architecture), so consider explicitly linking to the canonical files (tests/README.md, design/*, existing install docs) instead of duplicating full command sequences to reduce future drift and maintenance overhead.
- Several commands and paths in the guides (e.g., manifests/autotune/... JSON files, deploy.sh flags, service names/ports) are hard-coded; it would be helpful to cross-check these against current manifests and scripts and either reference them symbolically (or via links) or call out assumptions so they don’t silently go out of sync when the deployment model changes.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The new onboarding docs re-describe a lot of existing workflows (e.g., tests, APIs, architecture), so consider explicitly linking to the canonical files (tests/README.md, design/*, existing install docs) instead of duplicating full command sequences to reduce future drift and maintenance overhead.
- Several commands and paths in the guides (e.g., manifests/autotune/... JSON files, deploy.sh flags, service names/ports) are hard-coded; it would be helpful to cross-check these against current manifests and scripts and either reference them symbolically (or via links) or call out assumptions so they don’t silently go out of sync when the deployment model changes.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Added a comprehensive Bob skill to streamline new team member onboarding for the Kruize Autotune project.
What is a Bob Skill?
Bob skills are reusable instruction sets that teach Bob AI specialized workflows. This skill provides step-by-step onboarding guidance for
new developers joining the Kruize team.
Changes
.bob/skills/onboarding/directory with onboarding skillWhat This Enables
New team members can now:
Onboarding Phases Covered
How to Use
Bob will automatically activate this skill when asked about onboarding:
"Help me onboard a new team member"
"Guide a new joinee through Kruize setup"
New team members can also read the documentation directly in
.bob/skills/onboarding/Type of change
How has this been tested?
Please describe the tests that were run to verify your changes and steps to reproduce. Please specify any test configuration required.
Test Configuration
Checklist 🎯
Additional information
Include any additional information such as links, test results, screenshots here
Summary by Sourcery
Add a new Bob onboarding skill for Kruize Autotune with comprehensive documentation for setup, architecture, code structure, testing, APIs, and first contribution workflow to streamline new joinee onboarding.
Documentation: