bitsandbytes/pr_1908/en/_app/immutable/nodes/2.76a557fe.js

import{s as lt,n as at,o as st}from"../chunks/scheduler.8a2cc2fa.js";import{S as mt,i as rt,e as s,s as o,c as r,h as ut,a as m,d as i,b as l,f as nt,g as u,j as M,k as ot,l as ft,m as n,n as f,t as c,o as p,p as d}from"../chunks/index.7079e750.js";import{C as ct,H as R,E as pt}from"../chunks/MermaidChart.svelte_svelte_type_style_lang.2b7ce466.js";function dt(V){let a,E,H,I,g,D,h,U,$,z,b,G,y,X="<li>Install pre-commit hooks with <code>pip install pre-commit</code>.</li> <li>Run <code>pre-commit install</code> once to install the hooks, so they will be run on every commit.</li> <li>If the hooks introduce changes, they’ll be visible with <code>git diff</code>. Review them and <code>git add</code> them if everything is fine, then re-execute the before commit, it should pass now.</li> <li>If you want to manually trigger the hooks, you may do <code>pre-commit run --all-files</code></li>",q,w,Y="Now all the pre-commit hooks will be automatically run when you try to commit and if they introduce some changes, you need to re-add the changed files before being able to commit and push.",F,v,N,x,Z="<li>Run <code>git config blame.ignoreRevsFile .git-blame-ignore-revs</code>. This will make it so that <code>git blame</code> is aware of commits that were logged to be solely formatting-related.</li>",j,_,A,C,tt="We’re following NumPy doc-string conventions with the only notable difference being that we use Markdown instead of Rich text format (RTF) for markup within the doc-strings.",O,T,et="Please see the existing documentation to see how to generate autodocs.",W,k,B,P,it='<li><a href="https://github.com/huggingface/doc-builder#readme" rel="nofollow">guideline for documentation syntax</a></li> <li>images shall be uploaded via PR in the <code>bitsandbytes/</code> directory <a href="https://huggingface.co/datasets/huggingface/documentation-images" rel="nofollow">here</a></li> <li>find the documentation builds for each PR in a link posted to the PR, such as <a href="https://moon-ci-docs.huggingface.co/docs/bitsandbytes/pr_1012/en/introduction" rel="nofollow">https://moon-ci-docs.huggingface.co/docs/bitsandbytes/pr_1012/en/introduction</a></li>',J,L,K,S,Q;return g=new ct({props:{containerStyle:"float: right; margin-left: 10px; display: inline-flex; position: relative; z-index: 10;"}}),h=new R({props:{title:"Contribution Guide",local:"contribution-guide",headingTag:"h1"}}),$=new R({props:{title:"Setup",local:"setup",headingTag:"h2"}}),b=new R({props:{title:"Setup pre-commit hooks",local:"setup-pre-commit-hooks",headingTag:"h3"}}),v=new R({props:{title:"Ignore formatting revs",local:"ignore-formatting-revs",headingTag:"h3"}}),_=new R({props:{title:"Doc-string syntax",local:"doc-string-syntax",headingTag:"h2"}}),k=new R({props:{title:"Documentation",local:"documentation",headingTag:"h2"}}),L=new pt({props:{source:"https://github.com/bitsandbytes-foundation/bitsandbytes/blob/main/docs/source/contributing.mdx"}}),{c(){a=s("meta"),E=o(),H=s("p"),I=o(),r(g.$$.fragment),D=o(),r(h.$$.fragment),U=o(),r($.$$.fragment),z=o(),r(b.$$.fragment),G=o(),y=s("ul"),y.innerHTML=X,q=o(),w=s("p"),w.textContent=Y,F=o(),r(v.$$.fragment),N=o(),x=s("ul"),x.innerHTML=Z,j=o(),r(_.$$.fragment),A=o(),C=s("p"),C.textContent=tt,O=o(),T=s("p"),T.textContent=et,W=o(),r(k.$$.fragment),B=o(),P=s("ul"),P.innerHTML=it,J=o(),r(L.$$.fragment),K=o(),S=s("p"),this.h()},l(t){const e=ut("svelte-u9bgzb",document.head);a=m(e,"META",{name:!0,content:!0}),e.forEach(i),E=l(t),H=m(t,"P",{}),nt(H).forEach(i),I=l(t),u(g.$$.fragment,t),D=l(t),u(h.$$.fragment,t),U=l(t),u($.$$.fragment,t),z=l(t),u(b.$$.fragment,t),G=l(t),y=m(t,"UL",{"data-svelte-h":!0}),M(y)!=="svelte-96yzim"&&(y.innerHTML=X),q=l(t),w=m(t,"P",{"data-svelte-h":!0}),M(w)!=="svelte-1noivq4"&&(w.textContent=Y),F=l(t),u(v.$$.fragment,t),N=l(t),x=m(t,"UL",{"data-svelte-h":!0}),M(x)!=="svelte-1ycf2ss"&&(x.innerHTML=Z),j=l(t),u(_.$$.fragment,t),A=l(t),C=m(t,"P",{"data-svelte-h":!0}),M(C)!=="svelte-pya2s1"&&(C.textContent=tt),O=l(t),T=m(t,"P",{"data-svelte-h":!0}),M(T)!=="svelte-3sb6gr"&&(T.textContent=et),W=l(t),u(k.$$.fragment,t),B=l(t),P=m(t,"UL",{"data-svelte-h":!0}),M(P)!=="svelte-970n75"&&(P.innerHTML=it),J=l(t),u(L.$$.fragment,t),K=l(t),S=m(t,"P",{}),nt(S).forEach(i),this.h()},h(){ot(a,"name","hf:doc:metadata"),ot(a,"content",gt)},m(t,e){ft(document.head,a),n(t,E,e),n(t,H,e),n(t,I,e),f(g,t,e),n(t,D,e),f(h,t,e),n(t,U,e),f($,t,e),n(t,z,e),f(b,t,e),n(t,G,e),n(t,y,e),n(t,q,e),n(t,w,e),n(t,F,e),f(v,t,e),n(t,N,e),n(t,x,e),n(t,j,e),f(_,t,e),n(t,A,e),n(t,C,e),n(t,O,e),n(t,T,e),n(t,W,e),f(k,t,e),n(t,B,e),n(t,P,e),n(t,J,e),f(L,t,e),n(t,K,e),n(t,S,e),Q=!0},p:at,i(t){Q||(c(g.$$.fragment,t),c(h.$$.fragment,t),c($.$$.fragment,t),c(b.$$.fragment,t),c(v.$$.fragment,t),c(_.$$.fragment,t),c(k.$$.fragment,t),c(L.$$.fragment,t),Q=!0)},o(t){p(g.$$.fragment,t),p(h.$$.fragment,t),p($.$$.fragment,t),p(b.$$.fragment,t),p(v.$$.fragment,t),p(_.$$.fragment,t),p(k.$$.fragment,t),p(L.$$.fragment,t),Q=!1},d(t){t&&(i(E),i(H),i(I),i(D),i(U),i(z),i(G),i(y),i(q),i(w),i(F),i(N),i(x),i(j),i(A),i(C),i(O),i(T),i(W),i(B),i(P),i(J),i(K),i(S)),i(a),d(g,t),d(h,t),d($,t),d(b,t),d(v,t),d(_,t),d(k,t),d(L,t)}}}const gt='{"title":"Contribution Guide","local":"contribution-guide","sections":[{"title":"Setup","local":"setup","sections":[{"title":"Setup pre-commit hooks","local":"setup-pre-commit-hooks","sections":[],"depth":3},{"title":"Ignore formatting revs","local":"ignore-formatting-revs","sections":[],"depth":3}],"depth":2},{"title":"Doc-string syntax","local":"doc-string-syntax","sections":[],"depth":2},{"title":"Documentation","local":"documentation","sections":[],"depth":2}],"depth":1}';function ht(V){return st(()=>{new URLSearchParams(window.location.search).get("fw")}),[]}class wt extends mt{constructor(a){super(),rt(this,a,ht,dt,lt,{})}}export{wt as component};