Meta tags:
description=Definitions of CodeRabbit-specific terms and Git platform terminology used throughout the documentation.;

Headings (most frequently used words):

terms, request, merge, base, coderabbit, platform, actions, pre, checks, finishing, touches, knowledge, path, instructions, changes, branch, glossary, documentation, index, on, this, page, git, general, getting, started, pull, reviews, available, security, post, configuration, tools, plan, issue, management, resources, code, guidelines, fortune, high, level, summary, incremental, review, learnings, filters, based, profile, workflow, tone, walkthrough, head, source, status, check, labels, collapsed, section, docstring, glob, pattern, mcp, regex, sequence, diagram,

Text of the page (most frequently used words):
the (36), coderabbit (35), and (32), #review (25), that (18), for (17), branch (16), this (13), code (12), files (12), #checks (12), github (11), can (11), changes (11), are (11), base (10), documentation (9), terms (9), configuration (9), path (9), instructions (9), request (9), merge (9), comments (9), platform (8), status (8), from (8), azure (8), devops (8), bitbucket (8), gitlab (8), summary (8), issues (8), page (7), knowledge (7), see (7), your (7), reviews (7), all (7), source (7), walkthrough (7), overview (7), you (7), example (6), mcp (6), based (6), labels (6), learnings (6), pattern (5), matching (5), any (5), glob (5), which (5), section (5), not (5), tests (5), how (5), pre (5), issue (5), guidelines (5), resources (4), these (4), used (4), matches (4), with (4), tools (4), use (4), excludes (4), comment (4), docstring (4), collapsed (4), when (4), tool (4), git (4), finishing (4), touches (4), high (4), only (4), pull (4), custom (4), actions (4), glossary (4), agent (4), built (3), discord (3), get (3), support (3), reference (3), standard (3), diagram (3), changed (3), reviewers (3), sequence (3), servers (3), organization (3), file (3), applies (3), filters (3), uses (3), have (3), concepts (3), general (3), supported (3), block (3), content (3), default (3), tags (3), direct (3), where (3), before (3), merging (3), also (3), pass (3), like (3), head (3), new (3), terminology (3), across (3), sections (3), level (3), profile (3), feedback (3), security (3), rules (3), fortune (3), unit (3), docstrings (3), plan (3), search (3), linkedin (2), changelog (2), home (2), faqs (2), functions (2), services (2), over (2), syntax (2), more (2), than (2), starting (2), release (2), regex (2), integrations (2), context (2), external (2), sources (2), configured (2), during (2), src (2), directly (2), what (2), varies (2), coverage (2), software (2), engineering (2), referenced (2), throughout (2), official (2), name (2), equivalent (2), action (2), reviewer (2), needs (2), fixes (2), merged (2), required (2), called (2), prs (2), such (2), automation (2), fail (2), automated (2), check (2), target (2), destination (2), into (2), table (2), included (2), main (2), posts (2), comprehensive (2), multi (2), everything (2), include (2), through (2), settings (2), describe (2), writing (2), style (2), written (2), tone (2), signal (2), once (2), its (2), workflow (2), important (2), focused (2), without (2), controls (2), standards (2), description (2), linked (2), criteria (2), different (2), reads (2), includes (2), lock (2), dist (2), repo (2), repository (2), past (2), commits (2), already (2), incremental (2), complete (2), command (2), specific (2), copy (2), management (2), analysis (2), generate (2), post (2), available (2), quickstart (2), started (2), ide (2), sign (2), slack (2), index (2), hosted, mintlify, developer, powered, privacy, policy, service, schedule, demo, quick, links, pricing, blog, yes, was, helpful, uml, type, shows, order, interactions, between, components, time, auto, generates, help, understand, flow, regular, expressions, powerful, branches, setting, match, names, server, model, protocol, open, connecting, data, additional, using, wildcards, specify, rule, filename, directory, depth, prefix, typescript, under, embedded, describes, function, class, module, does, format, language, python, triple, quoted, strings, javascript, jsdoc, etc, measures, percentage, collapsible, hidden, expanded, clicking, html, wraps, one, collapse, enabled, details, wait, author, reject, decline, withhold, approval, blocks, formally, indicates, platforms, exact, natively, attached, categorization, filtering, urgent, feature, bug, build, commit, statuses, api, indicator, pending, shown, represents, result, process, contains, being, proposed, same, vary, naming, differs, comparison, every, suggested, among, others, appear, controlled, diagrams, free, text, field, should, communicate, affects, chat, responses, concise, explain, detail, junior, developers, note, many, posted, two, step, finds, submits, work, resolved, automatically, switches, approve, lets, teams, unblock, provides, overall, including, best, practices, minor, improvements, assertive, focuses, fewer, higher, bugs, essential, chill, most, inline, critical, major, impact, groups, else, conversation, stays, losing, quiet, much, gives, strict, think, volume, knob, validation, evaluates, title, quality, completeness, assessment, define, own, apply, tell, ensure, meaningful, descriptions, documents, test, patterns, control, folder, exclude, respond, prefer, early, returns, try, catch, remembers, preference, future, remembered, preferences, they, scoped, single, shared, collected, draws, conversations, tracker, jira, linear, pushed, has, been, reviewed, focusing, just, rather, scratch, avoids, repeating, made, previous, generated, purpose, key, human, appears, end, unless, placeholder, string, specifies, precise, injection, place, moved, random, fun, fact, tip, trivia, message, displayed, while, still, processing, replaced, actual, named, after, unix, common, cleanup, tasks, generating, triggered, checkbox, commenting, coderabbitai, team, coding, them, write, agents, claude, cursorrules, covers, definitions, enrichment, planner, handoff, refinement, create, per, guides, catalog, third, party, examples, inheritance, web, simplify, recipes, resolve, conflicts, autofix, creation, commands, manage, automatic, ast, slop, detection, pipeline, walkthroughs, summaries, hands, guide, getting, tour, architecture, line, extension, navigation, idea, leaving, skip, discover, pages, exploring, further, fetch, llms, txt, requests, cli,

Text of the page (random words):
coderabbit documentation ai code reviews on pull requests ide and cli documentation index fetch the complete documentation index at llms txt use this file to discover all available pages before exploring further skip to main content coderabbit agent for slack from idea to pull request without leaving slack get started coderabbit home page search k sign up sign up search navigation resources glossary coderabbit platform ide review extension command line review tool coderabbit agent management quickstart changelog support discord platform overview architecture platform tour getting started quickstart hands on guide pull request reviews overview pr summaries pr walkthroughs coderabbit review ci cd pipeline analysis linked issues slop detection path based review instructions ast based path instructions automatic review controls manage code reviews code review commands available actions issue creation pre merge checks built in checks custom checks security security agent post merge actions post merge actions finishing touches overview autofix resolve merge conflicts generate unit tests custom recipes simplify code generate docstrings knowledge base overview learnings code guidelines multi repo analysis mcp servers web search configuration configuration overview configuration inheritance configuration file configuration ui configuration examples tools third party tools tool catalog per tool guides tools configuration coderabbit plan overview create a plan plan refinement agent handoff issue planner issue management issue enrichment resources configuration reference glossary faqs on this page coderabbit terms code guidelines finishing touches fortune high level summary incremental review knowledge base learnings path filters path based instructions pre merge checks profile request changes workflow tone instructions walkthrough git platform terms base branch head source branch status check labels request changes collapsed section general terms docstring glob pattern mcp regex sequence diagram resources glossary copy page definitions of coderabbit specific terms and git platform terminology used throughout the documentation copy page this glossary covers terms specific to coderabbit git platform terminology that varies across github gitlab bitbucket and azure devops and general software engineering concepts referenced in the documentation coderabbit terms code guidelines files in your repository that describe your team s coding standards such as cursorrules claude md or agents md coderabbit reads these files and applies them as review criteria different from path based instructions which are rules you write directly in coderabbit s settings see knowledge base finishing touches automated actions in the pr for common cleanup tasks like generating docstrings and writing unit tests triggered through a checkbox in the walkthrough or by commenting coderabbitai see docstrings and unit tests fortune a random fun fact tip or trivia message displayed in the walkthrough while coderabbit is still processing the review replaced by the actual review summary content once complete named after the unix fortune command high level summary an ai generated summary of a pr s purpose and key changes written for human reviewers by default appears in the pr description at the end unless a placeholder string specifies a precise injection place and can be moved to the walkthrough comment incremental review when new commits are pushed to a pr that has already been reviewed coderabbit can re review focusing on just the new changes rather than starting from scratch this avoids repeating comments already made on previous commits knowledge base the collected context coderabbit draws on during reviews this includes learnings from past review conversations issues from your tracker past prs code guidelines files and integrations with jira linear and mcp servers see knowledge base learnings when you respond to coderabbit s review comments for example we prefer early returns over try catch in this repo coderabbit remembers that preference and applies it to future reviews these remembered preferences are called learnings they can be scoped to a single repository or shared across your organization see learnings path filters glob patterns that control which files coderabbit includes in or excludes from a review for example dist excludes all files in the dist folder and lock excludes lock files files not matching any exclude pattern are included by default path based instructions custom review rules that only apply to files matching a glob pattern for example you can tell coderabbit to ensure all tests have meaningful descriptions only for files matching test ts different from code guidelines which are reference documents coderabbit reads see review instructions pre merge checks validation rules coderabbit evaluates before a pr is merged built in checks include docstring coverage pr title quality pr description completeness and linked issue assessment you can also define custom checks with your own pass fail criteria see pre merge checks profile controls how much feedback coderabbit gives you and how strict its standards are think of it as a volume knob for review comments quiet posts only the most important comments inline critical and major issues that are also high impact and groups everything else into collapsed sections in the review summary so your pull request conversation stays focused without losing any feedback chill focuses on important issues you get fewer higher signal comments focused on bugs security issues and essential fixes assertive provides comprehensive feedback with more comments overall including style best practices and minor improvements request changes workflow a two step automation when coderabbit finds issues it submits a request changes review on github to signal the pr needs work once all coderabbit comments are resolved and pre merge checks pass coderabbit automatically switches its review to approve this lets teams use coderabbit as a required reviewer that can block or unblock merging tone instructions a free text field where you describe how coderabbit should communicate this affects the writing style of all review comments and chat responses for example be concise and direct or explain issues in detail for junior developers note that this only changes how comments are written not how many are posted use profile for that walkthrough the main summary comment that coderabbit posts on every pr it s a comprehensive multi section overview of everything that changed sections include a high level summary a table of changed files sequence diagrams suggested labels and reviewers and finishing touches among others which sections appear can be controlled through the review settings git platform terms terminology for the same concepts can vary across github gitlab bitbucket and azure devops where the naming differs a comparison table is included base branch the branch that a pr is merging changes into this is the destination not the source github gitlab bitbucket azure devops base branch target branch destination branch target branch head source branch the branch that contains the new changes being proposed in the pr github gitlab bitbucket azure devops head branch source branch source branch source branch status check an indicator pass pending fail shown on a pr that represents the result of an automated process like ci tests or a code review tool like coderabbit github gitlab bitbucket azure devops status checks ui commit statuses api external status checks build status pr status status checks labels tags attached to prs or issues for categorization such as bug feature or urgent used for filtering automation and organization github gitlab bitbucket azure devops labels labels not supported natively labels also called tags request changes a review action where the reviewer formally indicates the pr needs fixes before it can be merged can block merging if required reviews are configured not all platforms have this exact action github gitlab bitbucket azure devops request changes blocks merge no direct equivalent withhold approval no direct equivalent decline wait for author reject collapsed section a block of content in a pr comment that is hidden by default and expanded by clicking uses html details and summary tags coderabbit wraps the walkthrough in one when collapse walkthrough is enabled github gitlab bitbucket azure devops collapsed section collapsible section supported no official name supported no official name general terms standard software engineering concepts referenced throughout coderabbit documentation docstring a documentation comment embedded directly in source code that describes what a function class or module does format varies by language python uses triple quoted strings javascript uses jsdoc etc docstring coverage measures what percentage of functions have these glob pattern a file matching syntax using wildcards used in path filters and path based instructions to specify which files a rule applies to matches any filename matches any directory depth and prefix excludes example src ts matches all typescript files under src mcp model context protocol an open standard for connecting ai tools to external data sources and services coderabbit can use mcp servers configured for your organization as additional knowledge sources during reviews see mcp server integrations regex regular expressions a pattern matching syntax more powerful than glob used in the base branches setting to match branch names example release matches any branch starting with release sequence diagram a standard uml diagram type that shows the order of interactions between components functions or services over time coderabbit auto generates these from changed code to help reviewers understand the flow was this page helpful yes no configuration reference faqs i coderabbit home page x linkedin github discord resources blog pricing changelog support knowledge base quick links schedule a demo get support status page terms of service privacy policy x linkedin github discord powered by this documentation is built and hosted on mintlify a developer documentation platform