152 lines
No EOL
33 KiB
HTML
152 lines
No EOL
33 KiB
HTML
<!doctype html>
|
||
<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-support/contribute" data-has-hydrated="false">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta name="generator" content="Docusaurus v3.9.2">
|
||
<title data-rh="true">Contribute to OpenRAG | OpenRAG</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.openr.ag/support/contribute"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Contribute to OpenRAG | OpenRAG"><meta data-rh="true" name="description" content="There are several ways you can interact with the OpenRAG community and contribute to the OpenRAG codebase."><meta data-rh="true" property="og:description" content="There are several ways you can interact with the OpenRAG community and contribute to the OpenRAG codebase."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.openr.ag/support/contribute"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/support/contribute" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.openr.ag/support/contribute" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://SMEA51Q5OL-dsn.algolia.net" crossorigin="anonymous"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"Contribute to OpenRAG","item":"https://docs.openr.ag/support/contribute"}]}</script><link rel="search" type="application/opensearchdescription+xml" title="OpenRAG" href="/opensearch.xml">
|
||
|
||
|
||
<script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("consent","default",{ad_storage:"denied",ad_user_data:"denied",ad_personalization:"denied",analytics_storage:"denied"})</script>
|
||
<script>!function(){function e(){if(void 0!==window.truste&&window.truste.cma){var e=window.truste.cma.callApi("getConsent",window.location.href)||{},n=1===e[2],t=1===e[3];gtag("consent","update",{ad_storage:n?"granted":"denied",ad_user_data:n?"granted":"denied",ad_personalization:n?"granted":"denied",analytics_storage:t?"granted":"denied"})}}window.addEventListener&&(window.addEventListener("cm_data_subject_consent_changed",e),window.addEventListener("cm_consent_preferences_set",e)),"complete"===document.readyState?e():window.addEventListener("load",e)}()</script>
|
||
<script>window._ibmAnalytics={settings:{name:"DataStax",tealiumProfileName:"ibm-subsidiary"},trustarc:{privacyPolicyLink:"https://ibm.com/privacy"}},window.digitalData={page:{pageInfo:{ibm:{siteId:"IBM_DataStax"}},category:{primaryCategory:"PC230"}}}</script>
|
||
<script src="//1.www.s81c.com/common/stats/ibm-common.js" async="true"></script><link rel="stylesheet" href="/assets/css/styles.29e42e49.css">
|
||
<script src="/assets/js/runtime~main.a09b72d8.js" defer="defer"></script>
|
||
<script src="/assets/js/main.e1ba3126.js" defer="defer"></script>
|
||
</head>
|
||
<body class="navigation-with-keyboard">
|
||
<svg style="display: none;"><defs>
|
||
<symbol id="theme-svg-external-link" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol>
|
||
</defs></svg>
|
||
<script>!function(){var t=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",t||"light"),document.documentElement.setAttribute("data-theme-choice",t||"light")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><link rel="preload" as="image" href="/img/logo-openrag-light.svg"><link rel="preload" as="image" href="/img/logo-openrag-dark.svg"><div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="theme-layout-navbar navbar navbar--fixed-top"><div class="navbar__inner"><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/logo-openrag-light.svg" alt="OpenRAG Logo" class="themedComponent_mlkZ themedComponent--light_NVdE"><img src="/img/logo-openrag-dark.svg" alt="OpenRAG Logo" class="themedComponent_mlkZ themedComponent--dark_xIcU"></div></a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><a href="https://github.com/langflow-ai/openrag" target="_blank" class="navbar__item navbar__link header-github-link" aria-label="GitHub repository"></a><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="system mode" aria-label="Switch between dark and light mode (currently system mode)"><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_g3eP lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_g3eP darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_g3eP systemToggleIcon_QzmC"><path fill="currentColor" d="m12 21c4.971 0 9-4.029 9-9s-4.029-9-9-9-9 4.029-9 9 4.029 9 9 9zm4.95-13.95c1.313 1.313 2.05 3.093 2.05 4.95s-0.738 3.637-2.05 4.95c-1.313 1.313-3.093 2.05-4.95 2.05v-14c1.857 0 3.637 0.737 4.95 2.05z"></path></svg></button></div><div class="navbarSearchContainer_Bca1"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search (Meta+k)" aria-keyshortcuts="Meta+k"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 24 24" aria-hidden="true"><circle cx="11" cy="11" r="8" stroke="currentColor" fill="none" stroke-width="1.4"></circle><path d="m21 21-4.3-4.3" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="theme-layout-main main-wrapper mainWrapper_z2l0"><div class="docsWrapper_hBAB"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docRoot_UBD9"><aside class="theme-doc-sidebar-container docSidebarContainer_YfHR"><div class="sidebarViewport_aRkj"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/"><span title="About OpenRAG" class="linkLabel_WmDU">About OpenRAG</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/quickstart"><span title="Quickstart" class="linkLabel_WmDU">Quickstart</span></a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/install-options"><span title="Installation" class="categoryLinkLabel_W154">Installation</span></a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/tui"><span title="Use the TUI" class="linkLabel_WmDU">Use the TUI</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/manage-services"><span title="Manage services" class="linkLabel_WmDU">Manage services</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/agents"><span title="Flows" class="linkLabel_WmDU">Flows</span></a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/knowledge"><span title="Knowledge" class="categoryLinkLabel_W154">Knowledge</span></a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/chat"><span title="Chat" class="linkLabel_WmDU">Chat</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/reference/configuration"><span title="Environment variables" class="linkLabel_WmDU">Environment variables</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/reference/api-sdk-overview"><span title="APIs and SDKs" class="linkLabel_WmDU">APIs and SDKs</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" href="/support/contribute"><span title="Contribute to OpenRAG" class="linkLabel_WmDU">Contribute to OpenRAG</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/support/troubleshoot"><span title="Troubleshoot OpenRAG" class="linkLabel_WmDU">Troubleshoot OpenRAG</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a href="https://github.com/langflow-ai/openrag/releases" target="_blank" rel="noopener noreferrer" class="menu__link menuExternalLink_NmtK"><span title="Changelog" class="linkLabel_WmDU">Changelog</span><svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a></li></ul></nav></div></div></aside><main class="docMainContainer_TBSr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link">Contribute to OpenRAG</span></li></ul></nav><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Contribute to OpenRAG</h1></header><p>There are several ways you can interact with the OpenRAG community and contribute to the OpenRAG codebase.</p>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="star-openrag-on-github">Star OpenRAG on GitHub<a href="#star-openrag-on-github" class="hash-link" aria-label="Direct link to Star OpenRAG on GitHub" title="Direct link to Star OpenRAG on GitHub" translate="no"></a></h2>
|
||
<p>If you like OpenRAG, you can star the <a href="https://github.com/langflow-ai/openrag" target="_blank" rel="noopener noreferrer" class="">OpenRAG GitHub repository</a>.
|
||
Stars help other users find OpenRAG more easily, and quickly understand that other users have found it useful.</p>
|
||
<p>Because OpenRAG is open-source, the more visible the repository is, the more likely the codebase is to attract contributors.</p>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="watch-the-github-repository">Watch the GitHub repository<a href="#watch-the-github-repository" class="hash-link" aria-label="Direct link to Watch the GitHub repository" title="Direct link to Watch the GitHub repository" translate="no"></a></h2>
|
||
<p>You can watch the <a href="https://github.com/langflow-ai/openrag" target="_blank" rel="noopener noreferrer" class="">OpenRAG GitHub repository</a> to get notified about new releases and other repository activity.</p>
|
||
<p>To get release notifications only, select <strong>Releases only</strong>.</p>
|
||
<p>If you select <strong>Watching</strong>, you will receive notifications about new releases as well as issues, discussions, and pull requests. For information about customizing repository notifications, see the <a href="https://docs.github.com/en/subscriptions-and-notifications/how-tos/managing-subscriptions-for-activity-on-github/viewing-your-subscriptions" target="_blank" rel="noopener noreferrer" class="">GitHub documentation on repository subscriptions</a>.</p>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="request-enhancements-and-get-help-through-github">Request enhancements and get help through GitHub<a href="#request-enhancements-and-get-help-through-github" class="hash-link" aria-label="Direct link to Request enhancements and get help through GitHub" title="Direct link to Request enhancements and get help through GitHub" translate="no"></a></h2>
|
||
<p>You can report bugs, submit feature requests, and get help with OpenRAG through the GitHub repository.</p>
|
||
<p>The repository is the best place to report bugs and request enhancements to ensure that they are tracked by OpenRAG maintainers.</p>
|
||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="github-issues">GitHub issues<a href="#github-issues" class="hash-link" aria-label="Direct link to GitHub issues" title="Direct link to GitHub issues" translate="no"></a></h3>
|
||
<p>The <a href="https://github.com/langflow-ai/openrag/issues" target="_blank" rel="noopener noreferrer" class="">Issues page in the OpenRAG repository</a> is actively updated with bugs and feature requests.</p>
|
||
<div class="theme-admonition theme-admonition-tip admonition_xJq3 alert alert--success"><div class="admonitionHeading_Gvgb"><span class="admonitionIcon_Rf37"><svg viewBox="0 0 12 16"><path fill-rule="evenodd" d="M6.5 0C3.48 0 1 2.19 1 5c0 .92.55 2.25 1 3 1.34 2.25 1.78 2.78 2 4v1h5v-1c.22-1.22.66-1.75 2-4 .45-.75 1-2.08 1-3 0-2.81-2.48-5-5.5-5zm3.64 7.48c-.25.44-.47.8-.67 1.11-.86 1.41-1.25 2.06-1.45 3.23-.02.05-.02.11-.02.17H5c0-.06 0-.13-.02-.17-.2-1.17-.59-1.83-1.45-3.23-.2-.31-.42-.67-.67-1.11C2.44 6.78 2 5.65 2 5c0-2.2 2.02-4 4.5-4 1.22 0 2.36.42 3.22 1.19C10.55 2.94 11 3.94 11 5c0 .66-.44 1.78-.86 2.48zM4 14h5c-.23 1.14-1.3 2-2.5 2s-2.27-.86-2.5-2z"></path></svg></span>tip</div><div class="admonitionContent_BuS1"><p>The best way to promote a request or bug is to comment on an existing issue that matches your request.</p><p>Before you report a bug or submit a feature request, search for existing similar issues.
|
||
If you find one, add a comment with any relevant details instead of opening a new issue.</p><p>Highly active issues are more likely to receive attention from contributors.</p></div></div>
|
||
<p>Feature planning for OpenRAG is tracked through the <a href="https://github.com/langflow-ai/openrag/projects" target="_blank" rel="noopener noreferrer" class="">Projects page in the OpenRAG repository</a>.</p>
|
||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="github-discussions">GitHub discussions<a href="#github-discussions" class="hash-link" aria-label="Direct link to GitHub discussions" title="Direct link to GitHub discussions" translate="no"></a></h3>
|
||
<p>If you need help with your code or OpenRAG in general, you can visit the <a href="https://github.com/langflow-ai/openrag/discussions" target="_blank" rel="noopener noreferrer" class="">OpenRAG GitHub Discussions page</a>.</p>
|
||
<p>The OpenRAG team doesn't provide individual support over email, and the team believes that public discussions help more users by virtue of their discoverability.</p>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="community-guidelines-and-tips">Community guidelines and tips<a href="#community-guidelines-and-tips" class="hash-link" aria-label="Direct link to Community guidelines and tips" title="Direct link to Community guidelines and tips" translate="no"></a></h2>
|
||
<p>Because the OpenRAG repository is public, the OpenRAG team asks that you follow these guidelines when submitting questions and issues:</p>
|
||
<ul>
|
||
<li class=""><strong>Provide as many details as possible</strong>: Simply stating that a feature doesn't work isn't helpful. The OpenRAG team needs details in order to recreate and find the issue.</li>
|
||
<li class=""><strong>Explain what exactly went wrong</strong>: Include error messages and descriptions of <em>how</em> your code failed, not just the fact that it failed.</li>
|
||
<li class=""><strong>Retrace your steps</strong>: Explain what happened before the error, what you expected to happen instead of the error, and any recent changes you made, such as upgrading OpenRAG or a dependency.</li>
|
||
<li class=""><strong>Describe your environment</strong>: Include your operating system, OpenRAG version, Python version, and any other environment-related details that could have contributed to the issue.</li>
|
||
<li class=""><strong>Include snippets of the code that failed</strong>: Be sure to omit any sensitive values, and only provide parts that are relevant to the failure rather than the entire script. Providing code snippets makes it much easier to reproduce errors, troubleshoot, and provide specific advice.<!-- -->
|
||
<ul>
|
||
<li class="">If your submission includes long sections of code, logs, or tracebacks, wrap them in <a href="https://developer.mozilla.org/en/docs/Web/HTML/Element/details" target="_blank" rel="noopener noreferrer" class="">details tags</a> (<code><details> PASTE CODE HERE </details></code>) to collapse the content and make it easier to read your submission.</li>
|
||
</ul>
|
||
</li>
|
||
<li class=""><strong>Omit sensitive information</strong>: Other than the information available on your public GitHub profile, don't include sensitive or personally identifying data, such as security keys, full names, personal identification numbers, addresses, and phone numbers.</li>
|
||
<li class=""><strong>Be kind</strong>: Although bugs can be frustrating with any software, remember that your messages are read by real people who want to help. While you don't have to be saccharine, there's no need to be rude to get support.<!-- -->
|
||
<ul>
|
||
<li class="">Your issues and discussions are attached to your GitHub account, and they can be read by anyone on the internet, including current and potential employers and colleagues.</li>
|
||
<li class="">The OpenRAG repository is a public GitHub repository and, therefore, subject to the <a href="https://docs.github.com/en/site-policy/github-terms/github-community-code-of-conduct" target="_blank" rel="noopener noreferrer" class="">GitHub Code of Conduct</a>.</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="contribute-to-the-codebase">Contribute to the codebase<a href="#contribute-to-the-codebase" class="hash-link" aria-label="Direct link to Contribute to the codebase" title="Direct link to Contribute to the codebase" translate="no"></a></h2>
|
||
<p>If you want to contribute code to OpenRAG, you can do so by submitting a pull request (PR) to the OpenRAG GitHub repository.</p>
|
||
<p>See <a href="https://github.com/langflow-ai/openrag/blob/main/CONTRIBUTING.md" target="_blank" rel="noopener noreferrer" class="">CONTRIBUTING.md</a> to set up your development environment and learn about the contribution process.</p>
|
||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="tips-for-successful-submissions">Tips for successful submissions<a href="#tips-for-successful-submissions" class="hash-link" aria-label="Direct link to Tips for successful submissions" title="Direct link to Tips for successful submissions" translate="no"></a></h3>
|
||
<ul>
|
||
<li class="">
|
||
<p>Explain the motivation for your submission in the PR description.
|
||
Clarify how the change benefits the OpenRAG codebase and its users.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Keep PRs small and focused on a single change or set of related changes.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>If applicable, include tests that verify your changes.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Add documentation for new features, or edit existing documentation (if needed) when modifying existing code.
|
||
For more information, see <a href="#contribute-documentation" class="">Contribute documentation</a>.</p>
|
||
</li>
|
||
</ul>
|
||
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="use-of-ai-tools-in-contributions">Use of AI tools in contributions<a href="#use-of-ai-tools-in-contributions" class="hash-link" aria-label="Direct link to Use of AI tools in contributions" title="Direct link to Use of AI tools in contributions" translate="no"></a></h3>
|
||
<p>If you use AI tools to generate significant portions of the code in your PR, the OpenRAG team asks that you do the following:</p>
|
||
<ul>
|
||
<li class="">Consider disclosing significant use of AI tools in your pull request description, particularly if you are unable to expertly review your own code contributions. For example: <code>I used an AI tool to generate the code for <function>, but I am not an expert in <language>. There might be some inefficiencies or antipatterns present.</code></li>
|
||
<li class="">Avoid using AI tools to generate large volumes of code if you don't have personal knowledge of that language and the functionality being implemented. Instead, consider submitting a feature request to the <a href="https://github.com/langflow-ai/openrag/issues" target="_blank" rel="noopener noreferrer" class="">Issues page in the OpenRAG repository</a>.</li>
|
||
<li class="">Be critical when reviewing code or documentation generated by AI tools to ensure it is accurate, efficient, and avoids antipatterns and vulnerabilities.</li>
|
||
<li class="">Don't flood the repository with AI-generated pull requests.
|
||
Low quality and spam contributions can be closed without review at the discretion of the maintainers.
|
||
Repeated low-quality contributions can lead to a ban on contributions.</li>
|
||
</ul>
|
||
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="contribute-documentation">Contribute documentation<a href="#contribute-documentation" class="hash-link" aria-label="Direct link to Contribute documentation" title="Direct link to Contribute documentation" translate="no"></a></h2>
|
||
<p>The OpenRAG documentation is built using <a href="https://docusaurus.io/" target="_blank" rel="noopener noreferrer" class="">Docusaurus</a> and written in <a href="https://docusaurus.io/docs/markdown-features" target="_blank" rel="noopener noreferrer" class="">Markdown</a>.
|
||
For style guidance, see the <a href="https://developers.google.com/style" target="_blank" rel="noopener noreferrer" class="">Google Developer Documentation Style Guide</a>.</p>
|
||
<ol>
|
||
<li class="">
|
||
<p>Install <a href="https://nodejs.org/en/download/package-manager" target="_blank" rel="noopener noreferrer" class="">Node.js</a>.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Fork the <a href="https://github.com/langflow-ai/openrag" target="_blank" rel="noopener noreferrer" class="">OpenRAG GitHub repository</a>.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Add the new remote to your local repository on your local machine:</p>
|
||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token function" style="color:#d73a49">git</span><span class="token plain"> remote </span><span class="token function" style="color:#d73a49">add</span><span class="token plain"> FORK_NAME https://github.com/GIT_USERNAME/openrag.git</span><br></span></code></pre></div></div>
|
||
<p>Replace the following:</p>
|
||
<ul>
|
||
<li class=""><code>FORK_NAME</code>: A name for your fork of the repository</li>
|
||
<li class=""><code>GIT_USERNAME</code>: Your Git username</li>
|
||
</ul>
|
||
</li>
|
||
<li class="">
|
||
<p>Change to the <code>/docs</code> directory in your local repository:</p>
|
||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token builtin class-name">cd</span><span class="token plain"> openrag/docs</span><br></span></code></pre></div></div>
|
||
<p>If you're running a development container for code contributions, run the documentation build from outside the container on your host terminal.
|
||
The documentation build might not work properly when run from inside the development container workspace.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Install dependencies and start a local Docusaurus static site with hot reload:</p>
|
||
<div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token function" style="color:#d73a49">npm</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">install</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token function" style="color:#d73a49">npm</span><span class="token plain"> start</span><br></span></code></pre></div></div>
|
||
<p>The documentation is served at <code>http://localhost:3000</code>.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>To edit and create content, work with the <code>.mdx</code> files in the <code>openrag/docs/docs</code> directory.</p>
|
||
<p>Create new files in <code>.mdx</code> format.</p>
|
||
<p>Navigation is defined in <code>openrag/docs/sidebars.js</code>.</p>
|
||
<p>Most pages use a <code>slug</code> for shorthand cross-referencing, rather than supplying the full or relative directory path.
|
||
For example, if a page has a <code>slug</code> of <code>/cool-page</code>, you can link to it with <code>[Cool page](/cool-page)</code> from any other <code>/docs</code> page.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Recommended: After making some changes, run <code>npm run build</code> to build the site locally with more robust logging.
|
||
This can help you find broken links before creating a PR.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Create a pull request against the <code>main</code> branch of the OpenRAG repository with a clear title and description of your changes:</p>
|
||
<ul>
|
||
<li class="">Provide a clear title in the format of <code>Docs: <summary of change></code>. For example, <code>Docs: fix broken link on contributing page</code>. Pull request titles appear in OpenRAG's release notes, so they should explain what the PR does as explicitly as possible.</li>
|
||
<li class="">Explain why and how you made the changes in the pull request description.</li>
|
||
<li class="">If the pull request closes an issue, include <code>Closes #NUMBER</code> in the description, such as <code>Closes #1234</code>.</li>
|
||
<li class="">If you used AI tools to write significant portions of the documentation, consider disclosing this in the PR description.</li>
|
||
</ul>
|
||
</li>
|
||
<li class="">
|
||
<p>Add the <code>documentation</code> label to your pull request.</p>
|
||
</li>
|
||
<li class="">
|
||
<p>Keep an eye on your pull request in case an OpenRAG maintainer requests changes or asks questions.</p>
|
||
</li>
|
||
</ol>
|
||
<p>OpenRAG technical writers can directly edit documentation PRs to enforce style guidelines and fix errors.</p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col noPrint_WFHX"><a href="https://github.com/openrag/openrag/tree/main/docs/docs/support/contribute.mdx" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/reference/api-sdk-overview"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">APIs and SDKs</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/support/troubleshoot"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Troubleshoot OpenRAG</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#star-openrag-on-github" class="table-of-contents__link toc-highlight">Star OpenRAG on GitHub</a></li><li><a href="#watch-the-github-repository" class="table-of-contents__link toc-highlight">Watch the GitHub repository</a></li><li><a href="#request-enhancements-and-get-help-through-github" class="table-of-contents__link toc-highlight">Request enhancements and get help through GitHub</a><ul><li><a href="#github-issues" class="table-of-contents__link toc-highlight">GitHub issues</a></li><li><a href="#github-discussions" class="table-of-contents__link toc-highlight">GitHub discussions</a></li></ul></li><li><a href="#community-guidelines-and-tips" class="table-of-contents__link toc-highlight">Community guidelines and tips</a></li><li><a href="#contribute-to-the-codebase" class="table-of-contents__link toc-highlight">Contribute to the codebase</a><ul><li><a href="#tips-for-successful-submissions" class="table-of-contents__link toc-highlight">Tips for successful submissions</a></li><li><a href="#use-of-ai-tools-in-contributions" class="table-of-contents__link toc-highlight">Use of AI tools in contributions</a></li></ul></li><li><a href="#contribute-documentation" class="table-of-contents__link toc-highlight">Contribute documentation</a></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class="footer__title"></div><ul class="footer__items clean-list"><li class="footer__item"><div class="footer-links">
|
||
<span>© 2026 OpenRAG</span>
|
||
<span id="preferenceCenterContainer"> · <a href="#" onclick='return"undefined"!=typeof window&&window.truste&&window.truste.eu&&window.truste.eu.clickListener&&window.truste.eu.clickListener(),!1' style="cursor: pointer;">Manage Privacy Choices</a></span>
|
||
</div></li></ul></div></div></div></footer></div>
|
||
</body>
|
||
</html> |