bitsandbytes/pr_1137/en/_app/immutable/nodes/3.243404bd.js

import{s as st,n as at,o as mt}from"../chunks/scheduler.852ec091.js";import{S as rt,i as ut,g as s,s as o,r as _,A as ct,h as a,f as i,c as l,j as ot,u as T,x as C,k as lt,y as ft,a as n,v as P,d as k,t as L,w as M}from"../chunks/index.28275fd3.js";import{H,E as dt}from"../chunks/EditOnGithub.582011f0.js";function pt(V){let m,E,R,I,r,D,u,X="… still under construction … (feel free to propose materials, <code>bitsandbytes</code> is a community project)",U,c,j,f,q,d,Y="<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>",z,p,Z="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.",A,h,F,g,tt="<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>",N,$,G,b,et="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,y,it="Please see the existing documentation to see how to generate autodocs.",W,w,B,v,nt='<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,x,K,S,Q;return r=new H({props:{title:"Contributors guidelines",local:"contributors-guidelines",headingTag:"h1"}}),c=new H({props:{title:"Setup",local:"setup",headingTag:"h2"}}),f=new H({props:{title:"Setup pre-commit hooks",local:"setup-pre-commit-hooks",headingTag:"h3"}}),h=new H({props:{title:"Ignore formatting revs",local:"ignore-formatting-revs",headingTag:"h3"}}),$=new H({props:{title:"Doc-string syntax",local:"doc-string-syntax",headingTag:"h2"}}),w=new H({props:{title:"Documentation",local:"documentation",headingTag:"h2"}}),x=new dt({props:{source:"https://github.com/bitsandbytes-foundation/bitsandbytes/blob/main/docs/source/contributing.mdx"}}),{c(){m=s("meta"),E=o(),R=s("p"),I=o(),_(r.$$.fragment),D=o(),u=s("p"),u.innerHTML=X,U=o(),_(c.$$.fragment),j=o(),_(f.$$.fragment),q=o(),d=s("ul"),d.innerHTML=Y,z=o(),p=s("p"),p.textContent=Z,A=o(),_(h.$$.fragment),F=o(),g=s("ul"),g.innerHTML=tt,N=o(),_($.$$.fragment),G=o(),b=s("p"),b.textContent=et,O=o(),y=s("p"),y.textContent=it,W=o(),_(w.$$.fragment),B=o(),v=s("ul"),v.innerHTML=nt,J=o(),_(x.$$.fragment),K=o(),S=s("p"),this.h()},l(t){const e=ct("svelte-u9bgzb",document.head);m=a(e,"META",{name:!0,content:!0}),e.forEach(i),E=l(t),R=a(t,"P",{}),ot(R).forEach(i),I=l(t),T(r.$$.fragment,t),D=l(t),u=a(t,"P",{"data-svelte-h":!0}),C(u)!=="svelte-1mlh5eh"&&(u.innerHTML=X),U=l(t),T(c.$$.fragment,t),j=l(t),T(f.$$.fragment,t),q=l(t),d=a(t,"UL",{"data-svelte-h":!0}),C(d)!=="svelte-96yzim"&&(d.innerHTML=Y),z=l(t),p=a(t,"P",{"data-svelte-h":!0}),C(p)!=="svelte-1noivq4"&&(p.textContent=Z),A=l(t),T(h.$$.fragment,t),F=l(t),g=a(t,"UL",{"data-svelte-h":!0}),C(g)!=="svelte-1ycf2ss"&&(g.innerHTML=tt),N=l(t),T($.$$.fragment,t),G=l(t),b=a(t,"P",{"data-svelte-h":!0}),C(b)!=="svelte-pya2s1"&&(b.textContent=et),O=l(t),y=a(t,"P",{"data-svelte-h":!0}),C(y)!=="svelte-3sb6gr"&&(y.textContent=it),W=l(t),T(w.$$.fragment,t),B=l(t),v=a(t,"UL",{"data-svelte-h":!0}),C(v)!=="svelte-970n75"&&(v.innerHTML=nt),J=l(t),T(x.$$.fragment,t),K=l(t),S=a(t,"P",{}),ot(S).forEach(i),this.h()},h(){lt(m,"name","hf:doc:metadata"),lt(m,"content",ht)},m(t,e){ft(document.head,m),n(t,E,e),n(t,R,e),n(t,I,e),P(r,t,e),n(t,D,e),n(t,u,e),n(t,U,e),P(c,t,e),n(t,j,e),P(f,t,e),n(t,q,e),n(t,d,e),n(t,z,e),n(t,p,e),n(t,A,e),P(h,t,e),n(t,F,e),n(t,g,e),n(t,N,e),P($,t,e),n(t,G,e),n(t,b,e),n(t,O,e),n(t,y,e),n(t,W,e),P(w,t,e),n(t,B,e),n(t,v,e),n(t,J,e),P(x,t,e),n(t,K,e),n(t,S,e),Q=!0},p:at,i(t){Q||(k(r.$$.fragment,t),k(c.$$.fragment,t),k(f.$$.fragment,t),k(h.$$.fragment,t),k($.$$.fragment,t),k(w.$$.fragment,t),k(x.$$.fragment,t),Q=!0)},o(t){L(r.$$.fragment,t),L(c.$$.fragment,t),L(f.$$.fragment,t),L(h.$$.fragment,t),L($.$$.fragment,t),L(w.$$.fragment,t),L(x.$$.fragment,t),Q=!1},d(t){t&&(i(E),i(R),i(I),i(D),i(u),i(U),i(j),i(q),i(d),i(z),i(p),i(A),i(F),i(g),i(N),i(G),i(b),i(O),i(y),i(W),i(B),i(v),i(J),i(K),i(S)),i(m),M(r,t),M(c,t),M(f,t),M(h,t),M($,t),M(w,t),M(x,t)}}}const ht='{"title":"Contributors guidelines","local":"contributors-guidelines","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 gt(V){return mt(()=>{new URLSearchParams(window.location.search).get("fw")}),[]}class wt extends rt{constructor(m){super(),ut(this,m,gt,pt,st,{})}}export{wt as component};