From 0646335b53737ac250aea60f91934e6ea366cc82 Mon Sep 17 00:00:00 2001 From: Nikoleta-v3 Date: Thu, 22 Aug 2024 20:54:41 +0200 Subject: [PATCH 1/6] Add license --- LICENSE | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..4315c83 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 Nikoleta Glynatsi and Sebastian Berg + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file From d66d5b031f9ec3073736c926e726b67652102b34 Mon Sep 17 00:00:00 2001 From: Nikoleta-v3 Date: Thu, 22 Aug 2024 20:54:58 +0200 Subject: [PATCH 2/6] Add code of conduct --- CODE_OF_CONDUCT | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 CODE_OF_CONDUCT diff --git a/CODE_OF_CONDUCT b/CODE_OF_CONDUCT new file mode 100644 index 0000000..ab9052e --- /dev/null +++ b/CODE_OF_CONDUCT @@ -0,0 +1,8 @@ +Code of conduct +--------------- + +This tutorial adheres to the [EuroSciPy Code of +Conduct](https://euroscipy.org/2024/code_of_conduct.html). We are committed to +providing a welcoming and inclusive environment for all participants. Please +make sure to familiarize yourself with the conference's guidelines to ensure a +positive experience for everyone. \ No newline at end of file From 8111fcdb6a2c29e9c3e3928a9f7f8f7c6c0a1087 Mon Sep 17 00:00:00 2001 From: Nikoleta-v3 Date: Thu, 22 Aug 2024 21:52:43 +0200 Subject: [PATCH 3/6] updating the online documentation structure --- .../doctrees/contributing/branching.doctree | Bin 0 -> 5147 bytes .../contributing/contributing_docs.doctree | Bin 0 -> 17640 bytes .../contributing_function.doctree | Bin 0 -> 12916 bytes .../contributing/contributing_test.doctree | Bin 0 -> 11349 bytes .../doctrees/contributing/forking.doctree | Bin 0 -> 9042 bytes .../build/doctrees/contributing/index.doctree | Bin 34409 -> 10280 bytes .../installation.doctree} | Bin 2734 -> 2135 bytes .../contributing/pull_request.doctree | Bin 0 -> 9568 bytes docs/build/doctrees/environment.pickle | Bin 17425 -> 27975 bytes .../doctrees/how-to/examplefuction.doctree | Bin 2921 -> 0 bytes docs/build/doctrees/index.doctree | Bin 6119 -> 6790 bytes .../build/doctrees/installation/index.doctree | Bin 0 -> 6371 bytes docs/build/doctrees/source/listwiz.doctree | Bin 7863 -> 0 bytes docs/build/doctrees/source/modules.doctree | Bin 2735 -> 0 bytes .../_sources/contributing/branching.rst.txt | 23 ++ .../contributing/contributing_docs.rst.txt | 89 +++++ .../contributing_function.rst.txt | 84 +++++ .../contributing/contributing_test.rst.txt | 58 ++++ .../_sources/contributing/forking.rst.txt | 47 +++ .../html/_sources/contributing/index.rst.txt | 269 ++------------- .../contributing/installation.rst.txt | 0 .../contributing/pull_request.rst.txt | 60 ++++ .../_sources/how-to/examplefuction.rst.txt | 4 - docs/build/html/_sources/how-to/index.rst.txt | 7 - docs/build/html/_sources/index.rst.txt | 11 +- .../html/_sources/installation/index.rst.txt | 39 +++ .../html/_sources/source/listwiz.rst.txt | 37 --- .../html/_sources/source/modules.rst.txt | 7 - .../branching.html} | 47 ++- .../html/contributing/contributing_docs.html | 196 +++++++++++ .../contributing/contributing_function.html | 197 +++++++++++ .../html/contributing/contributing_test.html | 172 ++++++++++ docs/build/html/contributing/forking.html | 160 +++++++++ docs/build/html/contributing/index.html | 314 +++++------------- .../installation.html} | 26 +- .../build/html/contributing/pull_request.html | 170 ++++++++++ docs/build/html/genindex.html | 3 +- docs/build/html/index.html | 23 +- .../html/{how-to => installation}/index.html | 55 ++- docs/build/html/objects.inv | Bin 286 -> 951 bytes docs/build/html/search.html | 3 +- docs/build/html/searchindex.js | 2 +- docs/build/html/source/listwiz.html | 120 ------- docs/conf.py | 2 +- docs/contributing/branching.rst | 23 ++ docs/contributing/contributing_docs.rst | 89 +++++ docs/contributing/contributing_function.rst | 84 +++++ docs/contributing/contributing_test.rst | 58 ++++ docs/contributing/forking.rst | 47 +++ docs/contributing/index.rst | 269 ++------------- docs/contributing/installation.rst | 0 docs/contributing/pull_request.rst | 60 ++++ docs/index.rst | 8 +- docs/installation/index.rst | 39 +++ 54 files changed, 1954 insertions(+), 948 deletions(-) create mode 100644 docs/build/doctrees/contributing/branching.doctree create mode 100644 docs/build/doctrees/contributing/contributing_docs.doctree create mode 100644 docs/build/doctrees/contributing/contributing_function.doctree create mode 100644 docs/build/doctrees/contributing/contributing_test.doctree create mode 100644 docs/build/doctrees/contributing/forking.doctree rename docs/build/doctrees/{how-to/index.doctree => contributing/installation.doctree} (50%) create mode 100644 docs/build/doctrees/contributing/pull_request.doctree delete mode 100644 docs/build/doctrees/how-to/examplefuction.doctree create mode 100644 docs/build/doctrees/installation/index.doctree delete mode 100644 docs/build/doctrees/source/listwiz.doctree delete mode 100644 docs/build/doctrees/source/modules.doctree create mode 100644 docs/build/html/_sources/contributing/branching.rst.txt create mode 100644 docs/build/html/_sources/contributing/contributing_docs.rst.txt create mode 100644 docs/build/html/_sources/contributing/contributing_function.rst.txt create mode 100644 docs/build/html/_sources/contributing/contributing_test.rst.txt create mode 100644 docs/build/html/_sources/contributing/forking.rst.txt create mode 100644 docs/build/html/_sources/contributing/installation.rst.txt create mode 100644 docs/build/html/_sources/contributing/pull_request.rst.txt delete mode 100644 docs/build/html/_sources/how-to/examplefuction.rst.txt delete mode 100644 docs/build/html/_sources/how-to/index.rst.txt create mode 100644 docs/build/html/_sources/installation/index.rst.txt delete mode 100644 docs/build/html/_sources/source/listwiz.rst.txt delete mode 100644 docs/build/html/_sources/source/modules.rst.txt rename docs/build/html/{how-to/examplefuction.html => contributing/branching.html} (52%) create mode 100644 docs/build/html/contributing/contributing_docs.html create mode 100644 docs/build/html/contributing/contributing_function.html create mode 100644 docs/build/html/contributing/contributing_test.html create mode 100644 docs/build/html/contributing/forking.html rename docs/build/html/{source/modules.html => contributing/installation.html} (71%) create mode 100644 docs/build/html/contributing/pull_request.html rename docs/build/html/{how-to => installation}/index.html (55%) delete mode 100644 docs/build/html/source/listwiz.html create mode 100644 docs/contributing/branching.rst create mode 100644 docs/contributing/contributing_docs.rst create mode 100644 docs/contributing/contributing_function.rst create mode 100644 docs/contributing/contributing_test.rst create mode 100644 docs/contributing/forking.rst create mode 100644 docs/contributing/installation.rst create mode 100644 docs/contributing/pull_request.rst create mode 100644 docs/installation/index.rst diff --git a/docs/build/doctrees/contributing/branching.doctree b/docs/build/doctrees/contributing/branching.doctree new file mode 100644 index 0000000000000000000000000000000000000000..35dcd6f0f9f94508e1da4e3e6908f9ac2421cc54 GIT binary patch literal 5147 zcmeHL-EJJW6}Bv`q}9(#a_s!HRx`03S4OkDYEhtt+TJ8U(893-1ZfcKa<%4g^r{#g|=Im6fB9C}!uR$UbGKq7Z zmX9&mBY7heJ*X6{8kSG^V!G(q-e3@fALcB@%ye>8inYh3-C)M#a#R>tB`eD^*3f9z zqJ(LUPJDM#HuGQWagi+=BNk0_KK3&Bka20dquM}O*fql@BwmUQyOPM1mk*chYR2HT zDaEqwhRrh3TCG<%9{y4DTn{J7JY`19VXmVg>kDZjA>t zJnef$Lnzn7w!pA)ZjftJ79-KMYnn$!sf2GMw*1ThV0E>41$kx&J64Y zEbt0lC?US`IX|P2zeMWW((R-O#LvWgVp-fd7VjPxBPMncd2!=$DQ@EbCjM{Z|D(rc zA$}qrK>WTJ7k911UAy)nAFG@Pr##R|0TayFlw6GjOD9|h zMg>M-%q3C~A=^H19b<`z;EQB2_f#fH5UW7yjfhsuvDTEIR_h%Ep9`rm7>szt3hm6D zvJ?tbFy%aRDr=KahaC^tNEIZo0gvDSrxif&I9D?#K4UU%`voJ4T!2sdgTVXeRR*!l zv1uxw2Qr1iOA9*ksVxq_SpI)Ju)#;=BJqCr>WTLoamOXxYMp>C@wO9bc+Qe=l&EOh zN`IS0g?a93gvtCeoHR{C3y zx`54}AFET;hzed%2P`WgynvGpkB>Aja&9;WX}t38hy;$lmSloXYnbl?Ci}IzuLmx>55%E;{y)Cd zR&LJQxk*Q8g$Zpmc<(=krmp*UUK+iY$-lNuUOX`E3T;Bk+6SjyPjK87Yy#@BN@@5F z(r*p`JG4uKmf8y|;a8r+H5~4}Fp>9B>NsP0H1&s^&uO0}3qZJil~l{EzrTF7?N!pk zYPW8++*%a>`@Z-Wj$K*)uPEIBz&~CG0Nz?SxCr!t-E*i)b;BAk+UGS9I&e&?7FqDE zHqGR1wsa3xmVNX*Te9!)vkYV*1V82Aoe_`2(L8jl^l2%ci!E*6dZ7r|EClu;P>dEH z*Phiz8`diB(snG_UR317Z^Mes9^0+D$1&hzyRNw*qyWv|YiK)YP-=Jz2EFJS7@2coWFoEJI_{n+c(NisnYuEb;`cZKI-)SUQcuTnB#T^U~fJ zD`iqZZ)*_De4D6nTFk;TP{%!W3DxBR zi_dwcauX)}geT?0>vlu1q-l2S9zTM+FxNX}d5Ty;0yK1np03Gp zgwvwRXSOHPtS}+ARmG6P^`kK3{;&I5;`{c+!I0;<%0uwrIN>?sOs+B50}>g|gImuA{sT7X8B1mcr8PO@D?7QziYv)6I8vu}Xtsyq&3 zj(bfEGZL9`Y*%rs8DotIhm1pznXxj0zWB_B!3kw&P-!g-zBWs;&dvndd1> zNa2p_L1m$b#$?@io+nAQ>8tqaEc& zl#yrs_YZ%Gc=qyfbV)t+EY#nx)uU1w1T(Ja-QX?$TRD2WnKfK{x?ayd)=QIB#K$`BJ0{ z|FlHT%tpXmZRT)6a6Czz+glN&rXk0bF9|`yK*s5*;hEj5F5^hnWb85R+%EITiLef9PQC*0wMizL34V<*Q!54dau2EQZ z@8YDZUS33VLGUjzU~R+SBjh<{RN(hJxZ}wcQ2!1+MBp?Fnu3XIjwgaApWzMQDxTs= zRPf|e$X)doV>{Imwq#dm|518>IR5xkI!FAY9H6a!0b TCiJ$p5fi{ySV+XB7!Cdn8Mv2= literal 0 HcmV?d00001 diff --git a/docs/build/doctrees/contributing/contributing_docs.doctree b/docs/build/doctrees/contributing/contributing_docs.doctree new file mode 100644 index 0000000000000000000000000000000000000000..f6b7e3d130e13bc78282d803fffdd8acbf013d64 GIT binary patch literal 17640 zcmeHPTZ|jmdDd-LBBfnx6-gVzQaq8RSdq1)oJ57QRt>l-C{|?2aV#r#YlS=H9P$iz zIK$3G+-+mjy(Ex;gVsP;AVBS+Zv~pqWJ6fyF3kMzI^? zVc<6$)^>fDzGmz38F9H*v%Zq}EzVkNU$L#3}_; zuzu#b>X0A2JLDCy9}~>g7Ppw7#~--O)(IW4<-o5F2~#oKw}DnXEvj}Lhi)^8 zK^7vze%FbBvN+iC>?p!Re4p{{p89skN&5MZrrlZ#SzC^oZ3kh`j)&p^p*R$k^`5sJ z^=%^Op?=6B7T#mSL>!Fm4y`ccN5!nBw_kr1@1uIh+wko;a_eE#s@qH4ja!_%Yk0NP zNnD35#lcc5@D;$W-=W_@pZQB_p*pw})y)Bg9}Rk43nK#3bA2|vv6r9XN0O$^PXl%S zIOzUy{5?VFr+gdQ{2U%Vd3TubC0^w``m>2U#|NSMmLHQ7Fj96R?wDD`(e-p2`*Y2L1MLR-@=)6taNP5 z?bw3cTb|uy9&@V8Eog$})dIS!HS0Eqq{@Nii6Qgsm^mZq1Q4o3ycC3*^?C|Iiw6PL z3w-=ZDDgut99V-OT*JGXl!o(sQQX)?1cy00zHG7s(s0moV;0(;N!t@638Lh5QOp(S zWGv0irHkiC93T?o0O34oj*CN{?ROHpgY!R2>~DkpUk1w;#o)st{uXp%o0Nh^g5Z85 z)dW>7zQEzGvLrb4e+)4yo+NPHvaME_v|QV>Al)$ugzaxwhW^Us=Xz{$=Jg{hA-z~l zde{+VOzo+IW{K4Gak^H&*fm691}!l~eu?wiY8(d`!yEkD~l* zAKklW&-0!qY14K+XbIRQ`Kuto>Vzw8k_&#cYB_EQ9TJ2aQW~qpN#NlibmN%$mg`%q zA$uhTL*pc54jJF-6&}a^Xt`b=3X%&+(C2*<9TL=gWvEMhh}#^gGb z67@qBKzvBmDq#PwqE9;VM)eMLGo)?}N~nwgrZPe~!;yuWQSigz-JKVni*YmEay zJ~AeM!<<}H7ChQsPrNPl#KmcNWNco9yaIoZwHX{CI4If&#L0c*gXF5F%h9sr7+`*T z42?`hdO$i+V)IgB7KkOGI~3P;M;xWk@lBjIqW^Nn@$0)L?usnh86uR5M*}8AyJe%^ zrT$rlH~$`~iO-5^#$ZQzdP;ttnBZ&~{3wdew=(pfp8EW0?$4@&YwYol)A3v{!2ed9 zn~23*aPa)3x}(IPS*6+xw&YJXG2>^F8T?1mXI328TQhJk(04MMyD&=gi~oV|6ojyo zWb}H0wV=M`b_z8Ee>Zy*->RHpw;2V8NOlBBD{o9L#~IYKkl%cC*(cV?#Tg>d|zt? zJ?L?`5)f^CNBrtACs*sA-#rQ#4ElvBoKtH2?p~N5136*!s4;M(45323F7Y zDfdB2qiy$G&$UDMcbGiZ5%b#Cz>T>)^O;RbBe|k)D2?5Q*0g+iXLg(@lZ?Qq0shsKSY`vXYESq ztQiVzVH0cg@vUUsGFG};T4`$4)+Jb^c3apa1I9jMAfCkO?tW?a;QT973*Y9y%Hp_- z1SEyABO8`8`mjO3F%V9s-X1g5+Y8z+)hWN5`hj?Kh4Rl7F+wdU$H;9JvU_7jWcs)J zweeIij1=j0Wc9j#n9Yzm()5osgjHGQQL)b#5V$*5_;NagGU9q zBaIadd@rz_>eP;So}R;E*dem+xwf_1cl)c$Dl+`z@p~325MiiAC<++QoixEZl zozgZXho|$Pg0gM6A&^N9JVgdRi}1SNqAe-NQ*ng` zVNskM&D(JdsE9{oa=ej+i)KDxMv8?t1p6T)##-N>n92aQ`#l77Bd*| zeuU*kY!OAR>BmKGK7WGm3>ol`eI>IL+ziSG%)BSM`*Lx1G zcdF8u(V*Yz1$UP%brGnt&zGz|f(x09&aR;XT>Zkeb|BftRDxmCWOcVWZh@qab!cw` zux0C#h5K&iT*McZ=#XDS)(h_8{>uvj=@d|U+z$pz0EmEb)INlkPq$X>0Cx{nA7@YA zY$D{qU4sF9O+jx(Nvnmd3epkP>TMj;7jEBt5!W0Y3Q{lwL4qVuoiNn*5&utp87BVH zsh^$fbJL&fONGN^oa{f+SDtjArL}Y;XS#8}v8n>eW*7``yG4pUVloR?3|cLiFc_$f zG&qWQkicC`V_#_tlvqd7KkV7amSxfATmc$Gg?zfCLJT$kvDCC|0kl?;Cr7_G_IS3m z$MmLvpp>TI^$(6zxocmh$z+D*N5|Q(f9!o}`sspqK$n8LM3W^4L-dj({=+FfuA(gwnfDU>9rLsEpEi6!XnaBt%J&hXI!8vGFfVZdO#{; z(5{@=^>uTl{GEp){>=gf^5ZE^D4LUrkOnF>5xHqH21uQe4H#pVNbip^OBI=e^IVi3 zrg66MB**lhroxoW&yTYi()_#(Fe;)-#f_UX06H^R;g^hhhcDy>sw=8i4UCr+YPwQR z`*MZbgH@{?20clhw45z1#?vm?f(|nI@f722%2Fvg@Lw4=+f@zb$gXI;Ob&Evr~L77no~P-Ir0GK^Du(-1Cm)h{VsIlb6D z%0ILFl>dxL`KPU^vB`<8SK2ADUo8{+H*;eD#^^hXoz~<%l)8L%_nGms$&AOX@z@$l zQ_s_+|A4MF_~aPx_*#Qdf;PwtC3bMF@u|tKHP&fM<60vHVNsYBQ{6JHA6BQ_DU10V zxtL3T#qfUe9E;UdCCd~^j!&2rQWrbY_ruBAKB-^ucDkh0_fNtvz#Zwf_!!IZ^d&EgcU_)Yr;HJ)IMEB@2u-U3WyopY1*ke`?b3 zII0_UB%cGElS~iZDal?>nq#Tm{daP3H$_hHbMtAUB2$<$Ud!Xc!oxAKAcC-bsq^CF zSv!V|I0G4U7Cf>czs9s@eqQ!knN##>DNY&D8ph0w6Xi{_{xE8*5|6U=K3W^{Yi_5} z+-S%u@;8Uw`2(QJvyoUFISRdKZvsjTFmcl`>wU9+K6IqPitQEitpr7}e%wg={BDUO z`ibnnyCn`qOeSm5lDR+#$`(t6I6itT(Em1j$M(?al_v^cyd^3f=A(HDRklO?pgSw* zkzOA^4y$b%SbGgWtLe`q^zdsg4q6RrSfsbuZU%6L8$)rd9Rx9IbP+ITFK_G>a}>|| zNw2X^eT}Fe7xPG3y8Q-a4=^>tl8>n;XeX0T8dNIS&~200F`bb1Q3Cmp^@A{OcS=SL^05=-H==FG`ceQNketp*Tq7$)3?U-6#f%qrz0|Lnp5I2-Q7@ z4*G3z$%L4-k=^td z5J{mts1F3Miz7e=jl^hsrS4%!O**V0lc&^udy>9k6Wo>281RNxbHMV$Xc5kSLPQs2 z;>Tlt2ZHFi$eRvt9(_{G_gOzb_Jqt4deXE3I~@-3QC$Fx$5Bm{iO8m))N zh*=NpiDgSK>o1+V^cm1|K5Vy2%hQv5`A_KOaae5$R=5s{jqN5* zkrVSF6xM0TWUrAO&#XMBp}LA6h@;VlAKU8>j;GU zi2SX7HsrM;9)q-};gJ9yFkYQEP+5`?v)7XT@PX|6R@FgD4?K{akgnf`3~0r0j8p{_ zV`-e*Lw*#S$=po2p+}uMy!mB*BofC8ugD0{ zyS(d}Uyf+~cJ_vvil{T3%mCUspS2@#kY1{1=av1q)}4bE=vK*={DA)h|2coZTSJ9K z_bK{#9fr4ihdzEpA3vmz85+M2ABm{Ya?}kk`_Scr_vLyI_z&*$pWl}&-IuF8kSjcp zvmYec5uVdrCm`~I=Fam%W~-P(!*?YrLbZ}?BqTIo>8e~&j=a7tO+kMG4*WZKqtmA!CZ)bR zHKo3@9i`~JY^GHAZ!m8gI+fDQchbx!+)HsRv%6Z0K8p;sMpe^O6@gg$B3{tv6>&DH<_ literal 0 HcmV?d00001 diff --git a/docs/build/doctrees/contributing/contributing_function.doctree b/docs/build/doctrees/contributing/contributing_function.doctree new file mode 100644 index 0000000000000000000000000000000000000000..e070f7a7c0fe06252014ccea950b4ba52f6369bd GIT binary patch literal 12916 zcmeHO>u(%a6;I;WjyH+(u8Eq!G;LZpcz2zapwvyO(zKyb8YfND5>-tnvpaY9&U$uc znMZ7+R-zS^V(ES;bPy5}s1hF$5~ykg5=ih3^&|fQNKhpH0r*sY=ia$9cQ=04h9Xf* zPG;`h$2sSo_c{LV@DIJmw#gr{FYa+KSg1L!8-y;4GqKAJn`xH?N%mg$=v&#F*`yeY zocTCRqbAG5Hq2;p&vzphWVi5foaQH9wWbGL~V z7U=mqZ?FYIN31yUos2LQBRvObB^f^$HylxMk|gpPX#%nk8HPMJ2FhZz={s?ZK|Bu! zPFFqca?@V<(r}t{5o^ggBdsv%I!PvW5{j7^Tj=^TanB)g?&?J>X3-s%rD8O3+O$K) z_lprt@2LJVzQ^^pzZf`4?A4>VS$C@3OPZW}bNEzkr=H8INmy-$fdbeI+VmdwSWs0P z)p1L4-JH<(Vz+P^bV;=+CO~~JVA#D~%b?rkJ-qBbiT3yg3Sj9_0d;J%mxGNUeU@ML|Q7zTAc zHxq|VoHP~^nkN9sFfbV6XYmWjBn+c5lZYDp!$*j(CIR3u*w$ypC-LPoHOmCga;$*O zTg5?=BPZ6Jrub_T(99}mX8H8&a+KBh5jkJL^h+9eAhSy%Fa{oV+L6=a2AntV+rDkv ztaHa}I|;Lr&`LP7yf{u-Y$Z;^3R`j{V!bf-k}z7doWQjpnJymGL`-lJYcWi%`7rg} ziVxW_Z1bJniGddVZ7K`X;E9L~d zToN?>)Mai>^3f!p5O06}^vOy-c-`a!u->TeB`k7$<5I<;W$3BIVnXaTh-_@j&29Sy zSL`GbL1H1mn$5&6-wE2O(}vO+A)af2=UxY&O^CNX|C?KZTI?Quq|qS^UdxqGMN1E` zxupyl^v&Nd1;pb~$v4FD#B0QA5tyvoU=clgih+n#p*o>ggSKK!#kmbg);uJp(#M2u z$YP?K7elCsZNn&Wg2aLauu{_Fn%Cp7mCQ@w39U46@dfi-i-+?SoQny0lR5g57f9kf4{a`fj0c@%mBML}Q zGYY#B`X~$&Z3BBz*a2J+8y^NRH(BJVz4JdoL&KtcY%&OM7c#iFkIq`|h9%jJ<$p4l z59on-ZGY@z>5olq|l#wnX zZpm*5y#ZDld6_t|Hs{Ik?ypc0M46f5HcndW;aUZ{jw=fQN*$#^Dil%y8~-P%=_f>` zAfc;*WOYMVwp1Jpn)Y4c`n=yMP)F)1Q0V)bLN~t!{q&HPi@4;{%K6oPa#g|Nn8Gy3 zeU!x3Y75Svuk?H;At%&A4k2Bzs#WXSV#2Zf@!HwinW_Br>ep+J)gHr}pSIhJ)#=*l z$7`o6q#dBFW~@3#uvrhhxzJ~cQ`e?0{tTIqN)x^@)C@fQX$xAj8&_6G`n(lD|B~iJ zVhX`=U`^MiPp^e{E)idl_&-Qu?M`(LfR8ugQJpTOp%fo+gf4kCZ$(eoh^Imh!D^n$ z1?dw=XNA0IuR!xWac?k0p0$0D8A(UGxyP_IWgwQ>UOM+U(RR6(e{)!eolDW!6XS==S?K+I@f* zkcY6j(_lCRFK#)UrFQL{Ehwata+IhOwKdQ<_K{URTKYtDw(DWc=xV&`Ty~&nkCXhGz~kkTQB*finw6lME|w7@19T z(Nu-_xe3c)$U>QKasL~q8TZUL!gNJ)?3sRI6&`}vqwZOurZ2I7u(+W+8@!?C`VTE{ z=&DSZ$?PzdERb?bP_VI>OQ~vP*(lemiB92)d_zd3!Yi4xm-%c|Vqz#CmGXs1ZTY^X zBL3cIB0Iv`LLsM(QY6I@g^RRCV9#o97D}hom>~JLm|&D&27_kO^{beou?tjv^F0)N z@+yWgQeyg(4Piu+Dj4^?FLcs1xs1>CbKCP>bNYc)hrNIk443P{iiWI)n zU_M;AWisPdO9z>G;Ull~=nB9A?FRG1IlgO@15vK&d|2SJR>el>G9N!>R`^tEXMdi@ zKt-+dt9(nT^^aOBVQ9#>Ucqa*g(@S^jh6^Ie_S1eZVi>a{_lo;HYD@Flqx$hlIco^sTE#r#e2==rUu z>k}qjCk-B59f^{(dV|f9_Qh35dxOYna%Y}MrXfjcm8#wh%f7nxq#90cI1^<-kzZsQ#!119EN7+ITS!26Q_1ld_S?)(KVCN5XM^DCLV%b^fOM5fp7cs%aNkgp9EqeUW znTBNDb}`;eBWgdi^WMK%u}6={e!N++D`pABh-lM1K;>51b_o|eKmiZEa3il!**-4Q zRxiwou{I0PSA;-1!;6ddFzAnN4==mbF*f#|!)qmfO(P#~dy}wfQxhY7#c{)cD_YFN z!4^{VL6{(vD?VP{F7{Ha6{KBzfl~h{iimM)nd#XS*J5dmE$>$&2;bz0O_@epw^HK7 zd_mq@3FN6;ElO;k-C=%qd55TQ$1h%o#R0b9fmVr=q_LhfEQVdyNZUAW9PKp$XoVS2 zlwFLBB@ucq3GVE!7?(Y!HtJxZi&^N(Op{jiY&G`qe60VY&7vrbY*cVvpGBZEf!ai$ zfY{fm zjkpeuMI9be`+Ocifye=|#ILuMfNFB&?8F&WmcrHYE5g>5J5*%`*iCJ?t>pGrqBO#3jYHG&5 zD-PrdA26%mQfh5U46)!&hL~0CQtAZq3syvmLH0!0sv}u4&Vj+cb?W-&XZW629PIl< z`EUAGc0uzqG40Zz0)e!VNm8=ddG@Ch$oaT7E7(>SOXlZwc^KPvo#ht%T zh?(bca}hB&+NP-)-a29WF1iiq1oiU3%%USTZ`ME~vvQQ-guOhpdTE5*iPtdiI_8-@ zTK9M$!?|tUE_M<}q4EFH?8U2O;M8AxK;h{Z$Aw`3C zbJkw@zykQCC5tD0zgDyG?}8T$(!@&E2khc0xuzAaow`)Z_@SE_uZl5jFrm$Eu|cmt zc!RAGIbzF&cQT?>j1L@;m1O)_+;T+CNs`EGr3u(VY#8(07$l2BZQqGw4B~esaQf=k zgqse^kCxM3iC9Oj8SjKq-$^oYkVwo#b*=9&#RG@fIWdS>%%a;YOU0qY=@NvDPm6KQ z@1XfT%*V~HzaBVA>@}mf-E`{QOWK@!E10TxQ_p4fB&@f?Kq2e}UHT3OET}6$O-Lzj znhSJ;Rp_D9jhq2D@Ot-&{rmPUJGZ^AlQ1g@t%Nhn zi{q5VR^qg*up>tzHV9)c38Qt(30w=-=i-N2hy_k!t%s?#8m7Km^PxZlX*G;itT1R; z-wpdL2NV~;VG}r@+hqV0TT5;DiKSaC;7-tHH$>kknbfda(qLm;`k=~R3t-MmT}U#4s`B)=-I6J_{*2v7TjX@`5jFTQSe^wY--wiK+Rj~vf>qO+VAKA zF++|8K9Mv(Dzr&+d5hT+u{&Gy+vKx0=T8iCo(5t!H6HIS!GPajxDA-J!FJg1d(s>u zs|{=FvUovGkXc9r2in6pLtdfflIeSDZB4I@(m>h@c`7STp=eUJ(sQYAxB$yji*lW# zwec;>^&+_JEhw34NDEOX^}EBfs-M!9&9!@0kk1 zyIS62a){4b-zt*r#`a&B+lTF$#}78;d(xB_b|OaO@L}Ami1kyqTB}gk;YWdh zQ-nVnr6T$%aN~a<7x1d66)bdB9Hk`m&Yqfs!P6lTKAht`2JT2d1rAlkWPUH%EkA6p z7;=C22k=*!H>@ijGRvXRrgr)?oI{tLKCJ?L&qoqNd5O#%6hwD8*wJwW!T~>A zrC=nF9*oG~+k1{@>1KOl@P#HrDXEQF&4grnhiUZ* zc{*e=D=zN=#|&gfsVX&IEB0oA_p{JrsV+e2uf+}9e9r13phYdox)Ce^r%R&Aslg=%4vQROps#3Pd zi_J|7HPYlZt^&gfaxH}b-T%gEhJ?@VMBR$iis~5mOZbSAu%b(gZ+Nhf&Fedq&5Oo~ zrEIR>K&qpv3RKRLwV1WUVlI_9EL9`W?512rx+&ySDz}og9a#rKl`e+EQKbS%Vb9?f zZnt;+kr-Yt$uDhC%qT+S#RILZ=Qn_H>y!(m+7=6p+T7@^L(YAhTc>)N%Cf$Pnp$4+ zGDb==`Hsj$p{vJ=9rBJj12n1vMW}$?7kTO=zRDMM85$MC<+5gcnTH`tR7GXWcUsIx z$hJv2#p>wvGOw29|u60d->7M(?A7mIsyjgs%Vc(`M;c#T?UR*|hgT z4pO@LC#|h0G)!CX;0=X@k$djEuGG7?JxLEvMI{9}_FMA2RG?ApOSRwZ>RA-yC}mQ0 z{u&6o@A;k+c|TUpA!dF@#V_RNafPStBt=}47f@Bf z93I5Yy~R9#Bn|mpf#IHM$ggvdlE)XU-4IraK?BuF^Z+sRegz~p6T!=)BA6>ha8(y~ zrH=~OYEgyTl@b1V?^*mOlf@^j?GP_ns5kAFh37_D*f3bAirrLJ$5Rg8c@P2Tc zN~Y@FyJhODqf9+nx`NAj#!&KgS3I=$o`*j)dH6V61zSth|Sh-D9WfOSAO7o3oqS2guP_}m&dUdSbCG_( z-=t@NnZ*rClZwUxdW#oNvb6y!!FE~Dw_EGBe46+$>j{#_Yq6N!bQPKuJ_KG^VB)W_ z)aMqB9%xlS339)fYNrwPpxAi>$g()1M`UBhvY3cjLir$ib&gV(h3vgSxE{9Q5uJ!xJN$#Wc|ngHaqT@?|s8 zq<-iJ$I%5K4xmL#9LM8s7`bS~Liq&wQ`>`bEQ@hiNC#wsBc5xc3#sF+p+7)OIcXBw z<&Zc)-8PeM+8@}3;(@Vpz=O_3f#Vav$K(jO8^k33a%d2<)D3MkJz>=}Yz29{ZSIs> z0xP@i$-WhWWxHNXugD-I$MTRi2;LM&Kn&I59of_at;v_!RA`hfS5MF{9D>#%|83xy6^k =>9sy4yCHUtxco?fgDvM69hR2eQ zJOgImq+YTnG#0Pzup&3%864J0=w#n6%(L)YwrV%q5YzE`kT`2L_qyE2pKSP|61F%J z_wib1|0soB$6(ZP`K>-}ybC%xYfmET06q}BvNv#9vJksh(m}Q%8vOP(cv&hStGTgt)SJ5^;^t^39kbM&RBv&X4+V_Vza*E`8Ep9 z=%S;Jyu0FPUfhAQ`W@xgHpCbUZfEGl5);auzoY#cafraNXhf$xLiq~VwKWk8^@E+Ek#JcS|3`HfsH}{K!q&n#C zyt;hlI$d6>ofpnD@As_GThmhto;X}ELt4sVPi5|~%q}&()?B($a_>t|Vri@KZ<+)0 A>;M1& literal 0 HcmV?d00001 diff --git a/docs/build/doctrees/contributing/forking.doctree b/docs/build/doctrees/contributing/forking.doctree new file mode 100644 index 0000000000000000000000000000000000000000..e9c73f7eda4938c3a5cdd04336cf6aecb01caac2 GIT binary patch literal 9042 zcmeHNTaO&Y74~H>p7DCUwy}W(Lt$fkz46YhW0Qmh5rhdB87~Sr#1FB0Yr1QudbX!) z=&s(26cUJp#7gxLiRL|09ug_}5y=lo6bT6lDL)|MF~1<+slLvzJMkru7gn0pboHrI z=bSqCGapQU`r7#e_Rk!ThtdzXTio+P<%u{oM?B>w0}<-HF!TX+(T0R!QWF z)EoeWEB(NWM3~;i%Xxy=eh{~E1T&gPJyC6!(`K&KV$Q27+VI2PYAR>%rl!fYj{Hud zaVDK{*!N=KGqY~M;~0zhJ{|Hw_U(w546BC@cQ+!@&0z4w_pq;on=ehMA3pt9=!gB9_x~hQzXnm($wU zfvCMQ7p}HgEB1~c{i1h;By9_$ME^i-87L;%F6)1n1Rdl@~N9s;Oj!BE)_3J#ez9g zkiQqnEBn5#NPF@ANPE6U+N>3M1NYB+5g*E$WbZ5-I&k2YiZvTXs*gK~ndF;-o;03> z$6oXG>q)1QvM=H*Y#_Lm|BgzS%fnDxW+)6A$W zB-dP&S`XvZcDv_mnRHsN8noB^4HXE@mp89HfF)gSlCryj?`~Kzu95&(*GZMu89awp zA!sJHU8z(oGV$bumZFKRESHv4xFw>cB`d28rwUn)@t1xpUy)x5|-L zCb(8NLHL=OSVt=C)y&BpDRe3GMJr~CL|Vgfr;cN?hj|ws25v~Mn3o<_GiwBlGtof! z5C{wiZAG|4y!z??T$c-hd<~eZ8w&1Cx@HDUCy}4ZkX(7c6!gNl#Z3_0Y~X7V@t`iY zxw?fG98ZzG))0NTKapmNEIj4)U}KI1aHuKbIc5!u;wVhaV?Ym`$Gz@#qX2#`y*@rny zs%uW|u@zY*!m;Ojh+C9ZnuANJ{98;n@t1&+7}tPy`@J%+O1O8{`D3dAlnjI z_QM&8BhNyr)CYMF>IAx$bWV3aNqY@A}679`?SpVXyZM$+$-6D1((RDjfR_x`&cU zda5?}r;sj9;PW0FP{#Kwxm$m@i>|C>gsIBt3)8MwHH8m*9ENPI1sCzx(n{D~o~uw{ z@?7`lxN197`S9<7hV zzE0(-Q8}5}6JJrYg5~35`d34F=b;$CbdQQ$J8+zbd-G#Y)%;k)9LrO7rxPf5qn?v> zpJC>^F5>76V{75w0tq(9trD?Ln{_58+tQ-W(#G z5YeWfMpu7GH=Sj+7i!Y1a;Il)PP63)0h%XUVW2oVI&i`D?#*~2l)EV8A=e*dcTF#T zb3ckGi}-e_;-vo`Fcg-5=T~^Rk#`sU5M*Dv{|4x#R;$&F!~g+mmHi|{FF8Vvk9MW% z*cRI=yL$D9S0JoVRB$(_k2MOkvT}hf0XYUZA*-W%5CJ^n_&OmDaBvnC!&d7vn6D3`B$f7w{)U-(AmiIYP zo)twJylBS-`JTL4vFDVbnzV>}?N@HXoYA-RLIz}TQI7??6cQBxd)jayE{?MVE8CzqZ{BE`) z0%2DiN`akXUWOC%4fy~K%#-Rw+6ly_2-2H}OjGipe4I8X#I_Gvp#_t~1<GLL@Pjer)Fb5LLZ{-l_5cm6}GPyURaXj(vQ8V)UgWqDVy! z<|AGpBFLFYb#-cvt3;1tnYLI`b9U^_7>fSqP#`m(;jL&Wc0V!tVr;WnARb}}O6K)M zitH%wGeY91Yt13dH_a&wa#Z9wok>!DF^8ZpcY^&m~%MwomNX= zWt+a80unCA^JCr#1Q^MwoGlDOo;Pz~CWZ+hCSw2zt;xZht{;Foj9t&rHynZ_h+uHT zgw4a1AH^WJe1wXgAghArggq!?;17`E-CDS0=7(ZfnLRNxM=Ko;+Q~S~V?}=*%W-SC zqa{W;D(baUbDAJ60f2P07@*wKHY*duyDwPl?wgE0zHhClgeUv+wz6( z+B0DGZK($V4r^%MffadLrZTolx^_NBTV(-~;`gLb3#P zpNj_^hW1_pyN)5KQ}#J~bdYWHT(oB~n*%+#_{`oQWh+AL-bjY&uAQc5HD%@pcA-7W z^}{Z7pl}Q)$yLBHj=|ZcDh}hBHPYmJBZbZkI>Lhq?|=j;Fqhvorx6bLh9d^t51hPU zw`8Bl=h9Htpqsh1U2|B3n<*wS=1AsFV82jBAAMGuayr?x-zv@t5CzrJ_&EU7#-j;6 zny@EFR^z=LY zOH6}+sW)MNOklx3w$Qus^IZ$Lo5+(i&psn`9jhU+UC9P9^bGU%wF)Fcb~$k<{D-59~xC{DGTPLAM*qmDF1hSTG?@;3)e z6TZiegvrSsMO!Dp6@drDpIMt?WBn6I`J?o0*bzqJut@yGB1VrsJFs*?^<^|V=Hnf7 zcm~C46(I8;F37SV%6`az(q{Q}+($%O$TA&aMM`px>R+0gmnP;FLkARVKgLXcQnp2* z{!PHW0Jup%Q!vwc+&gHdNHt)rZ>+ug76l))l~C!y85Tbep}cK1!)K0`GO(I{)DPVt W@!;lEkGx~kqmYn$PfB<&>;4arz}ENx literal 0 HcmV?d00001 diff --git a/docs/build/doctrees/contributing/index.doctree b/docs/build/doctrees/contributing/index.doctree index 515ae7247a2fed4453a0048645b51ec2580a7c26..6ce2d4150f47be0c71eb741b0ce79bbdb9ba392c 100644 GIT binary patch literal 10280 zcmeHNO^h5z753l$%-Fm3I`#&z*R=Tw4)N|1lJH{%B5>q{IN3yzLE#X!Yr1QuYPYAm z(^c)=MFhbiD3*!?N=FDG!2ys02ZR6#IKz=cP8>LKL<9+;NF0z5e6OniX4bR2b|Qoz zmUg{e_3BmC`}ykCd-c_+SC=jvu>Z_)l?oYet*|hRlaQ;z%!Wyj4|%MMSBiVTR=ikT zFrAETswB?>UYG-*2!xEnjK{_Eg_$REEhDv3j-OFH&@zeZ;bKZmi<#$(3!-DDwA2xA zbs6s|w!uB-T~1=1$sSlGv8NO7dL)(JlwZ1DRAY}^<6E>SbN7TH#Y=@-?{vzrI$ekb z)A8%=h{I;O+{KzX63LhsYk3cgI&K%`XS~lb44bSrE~ZRpbRA;R%#;hOW)o+`d2v=8 z7E5d592hdwW!h~8;w14MmZ2h1%>)rs3XS-CDrQ6X*KC-l%}0*~8(0X@*0d*DP zy_jVo?{RT27>fIzFT^r_R`GK`ejWg^ct{)v(J{9a(_8(#;+a|Ocs&fv)92Eyb*8;P&Ziz0ZB`;DG~AH_GwS zELn%MDG%oE>FrboEQ+=vSEYIA!H?32>3)(8l@~$h-eXcfp7$=&|4%afpJd%c3)liQ zBej6Gxaaf^rG(rYvX~9PDOWNc(5Mw}vMO@LyKVxHVMVdWx7aX^_=yFcYfyWwxNj|7nQS{v%A?@wd>u98UcLyb_MX2Q2~tL*@&w4hiB8b z!ZY*c8l3=wY3rUA0)Po{Lg(Wb36Owngl^31^G$D<;7=J#jnl*f$fY=3s^N67bSpT~ zgf~47kLH#)Il0m-)6Hp9!UkbpiK9R&eDo#GHp|?Ts!Qini9Li58(z}4Fj)=(B86Tr zBVG)w)9vwojHfMifkSDod3LGN-2dg?8-sjxe+EfbSe=P;EgR~XqrE(exb`U;YegL{ z)Fk|%4qs|MZ1tMsm*C--u3v#Bp|k5&ctHV2;>1%weTNgpByTOmp(_VDFcZ#xD?UP7Fvam?3;C z%*p21jR!7%D=fZ-$&kso5Wh7um;(U>;`_rin>mW#d@GG)Aa!xmc5fnND_*wa;79|m zu{!byh{Z;qKPy9*lUUeKc3W6mr$qeYy@+1}(GQ)-C^(`RdzW21yC}@TWxK5Jx0Ypt z5CoLzhRH=w<$<6eNX9{w zlihgLC8UfyHZwpNg)LlZ1Yd|dB!x!Rj<9@{IFY62hxV)6!sKv)|=mQ*U|n40w} z#L0M?D2YgW+k#RbaXQ6Imas<2?q-rlp^FB=Y11NFyy88LYmWm;kt7OHdX1_q)--2H zc@YvC@?no>XzbR=*vnXqEw=#I$*;XD7tf2u=iZSyPLcnV%p1i0%Vf|Q$Ce6lPr>mj zpZP%*m{gbfA5{(JgaggbS|fn{x+{BgZxR2pDEaehK>7WvvF}CGsaZ5&xjq9IoxJo5 z;y3$&%Jn1QvO8`7@dz!&>uqRUU%J>tyz!9CW{21d|}f9|$m zA|_z`#|SWrMk{watz2$h?jOZveq1^0_mh0-6sz^qG}S6| zyVKjQl&AR4DD%uN#4hA)eDT{@nbmWn)VgWWoND`GHDOD!-=)!SS+U>QLpqZb`x?gG zmSRt}{jrLIMwGh*WqoUp<+PPc^snrLey4ILUu?yn#Tzt76-A#_PDdp9?K=5FLE;lal!$G5L z86Q`5#`+kM=0llP>$Q_FqOEZAnFtxVX8~=mjP*($8p(ZgHnXBxH@5G1d$jx zl-dTS_I4f!77w^OU)^N?_cvMxQR}~hDNXjLNpTeAg?AdrH*b0IfRZ)^jmw)T@KvY8jM4yCi)-8Smn z#DC$+8WsHEj#TjemI}r~*;dT7bgd<3P50Lq< zd#tC8wl`HwP(U$9LzDzEqwKfYa$2u68@@uIApkF(=FVkASroZlb3Wi zr^F*=8{wmlQYv^ZMmnccwUfP_EF16m05o;`0Cl0Y=??0jyZ_#-6M2l$EXooEWlLU94k-OzKq!4v<=!Wit~+d;W6tU$82TR>%(w{2k|-X^r(3|H7;+WY@70|U}J~Z`bUXN=?jh< z5^qgVWX@4dZ<)2K$4N}p zCa5@Q=7T(=(!XD}ubE?2i!1n>S;cKEgO?5q6a?9)3;hhYWTbctGyMe?0qq;hKfY!< z10EyYhtwL3q7xzuhwRoc#m7-M4U*9D20pvxXP!m)nuCaas^?QLrkf%yZ6h7qPZAv` znzuTy9yD_lCqm8s7R7}HTIO*y%had%3quuHo^dVQr3#f#Ra?J$Re%}G0p&9TY@U*W z8It4_LXg#U1&iv>DYL-0BxI$T&Q(P;Wu`*j%LkZlo^rl82tk3w=nyR(ow0z^rjQDr zmoaJ@KAub@l;lKCIoJK=Pb@2mzt4_#`aH{$%tz=LMzA)##K7JHAz}5-&fLiuEGeNV&?H z$|1zV<`_1k5YF4sALMf-nO^~!S){)(30{y8L_x#EEriOC0&MC}nCJp|6)Yznzz`#e zdqVNli4U3il&8&m8rlphC@Jh6YbWP0@2ZNMXjUufwid{UCfQ)MFsF&qE&!B1>NoU= z0qU4V`|<}r@*w0npY?+=_SDj_zo%jkXJurvc<{0!x$fIJ;P$IR4{6K6cQ%S znkCre(68N-Y9RJOkgrm*kelX&+Kx5b@`W6T2tTmjBT+)8e@r1L(EbZK{8~X!ciC_E z=|>43W}q4GewJ{1!g`>1=Wmd*6(L4%5p$ zGTta*&Kv28(?$WC!O0QAg}1Q;!8z4)P6wdc@Hxsqk&mZe8Mp6}UN#HmWfjI6^&PC; zG>3V7gPuy6SqCTZUzj553lh$ueOC>#yIa7bU|M+aLuM1wJEj)_cq6UutrMETtzUmo z<(-~Mp?!uL-QVj2`1pE=U&?f-nQBx-WIJvuaUcGqZgEVRxwhggr#V!wtd*0oxEAuy ziq0*$-Qwt=CMbH?OQPBqEa|DS#+te_!m(4$Y6qPh;cv?#gzcxtd6hjl-GLtV^$Wq| z(EwL92pQtU2{Ln;Ud5pO6^P)a;#qhC?t$KGk&))3b+c99(K5n-xeUlI QyCLCR2?=!k;_b}80auFkrT_o{ literal 34409 zcmeHQ4U8PuU5{g*?OT5*^|dB;n0z&7*SmL4oF+MvHjUG?X=3Ng4Gw9#H@iD`Gkd!; z+nHIPFHn?Jw9Ualg}R_3XrTxssDz3{Nhw8uMBB7f6etCWq6)RB(9)u+QV|ptiQoVK zK4EOMCqfZUqKA6rXV|O`;`f<}6WS5{s(+@hW*b4`b53;>fJPkTYP1fI$c+E73 zLS5aT@VEOr9v@8mli5TXq#e(Cl}(>^mpsRHno*d>K?6-ip_4{V>U)lY#O3y=4K%Us ztapK68>8ks2VxxCdoG|(2mXOa&%|1ZJi+W250&WH>Mqi&fxpkc!r$#5_P6>+vc}At z6E99?7CS4Unr-gH6C~+!@Wgy=AjmtF-Ts^!97s9=NizaTXZ$Nc3c$aQ`KAt(dY~ZqQ1PZe zkxgnq7!H3b+aV#d8obqR(Di>51of{1KV5@=*Wusw_;(b<@?YiOO#P$RsccKlY9R-b zSK30=KjI$;?zbs&qqUllC4b`FuWz~JlKVkGM-b5I#Zem~lQ>{bCtc|UO}Eoo0rHd7 zYdMgHUdK%rqPUwl9q@(oh9G@ozj2)Yzt6@0QCx{2Epc)jv`c-K9NBaeA`S9|?jl<1 zCqcMKwQ5e0OsFXd-%q@X=)iFSQRsLV+-|Sq)ts~IGQx3ZCF(n&hxWlKzI&czSvAmX zM*T3YRUSo=CfaJoo|~dT=(ysQ(^zpr_k6Gj2?uOwK~$Y{{50*&&CD!fK>bFo8Fc~l z0`~Ni<02neWox7P#SfGL2G^t@)U5Hw9W-6v4x%~hy_1U=|>YF1y0q0e3Q z60J1ehSJIsk_T-uBfYb(#2#2fT_w5eyfI4QF}v~MGMsHkr~Nn>_>Yq~KMEmykj43d z&E}z@1OEvn?AhTmK2xJEFJur9j*Ea^9sxOhmLt_@`fR(U&vvOHD&xLiJ;qSWb^Rl8wJM6U?=g*EdP8u9p)OU;GtaA6|RPFvtFS+D2^r+FXtf8QBQ)pc1 zEUBq9kbws++V$L!z$eWHy%I(#o4`ubcf&<5aauu)+E6vnSLCKx%9d0s)VABo>qVvb z;N|pIoM?fnRjg`GA0|7d4r3=;4i#8ROS&Pns}GC8mRNzoy}K#5S*x5SJC1=hy(Dq) zm5c}m=sL%aK_f05JH{HkMGyxVqtv=EIARP%M66TXU2WqqrmvrE7CvczDoG?4C z*jrHKDgQxjj3%{eQ1DN%s<5hlY4`wa!1G+YH?L`|=JJqyT0?UAI@(CVw98UaR#V?9 zf$R&TVl`*=bHI&e^$#c$3u(m+KIjtZtofHyt2z8|ZqAvhCn>!0<_swY*w9)pT&##e z4x4giTgg|;E?=kSAgjRswt^OB4KxSOwj3L@4?=AxphbHpz9`V-gzIp>VaAkANg%4Q z5LIpBSHO;P)~8Fb{mGTE=7SYAw^78j%~f=9tZOCO@`#P7wQtZkltBlhLSXg;VwALQqn}pYxkBA? ziox=6Z*2T{LjD3E+k$q@NR5h8`u-HrM30t!S@rKLAMM5Uk{SJ7QsF;0x*O3c4$UY7 zCGvKlM}=t|ON9E3_9VuqmG-*IO|ka)%FU`dXiuS|w-4H{z<=!?J}j+P6zS`1kv?}A zh0kCL1GNSJpF%fo$P&rZ3(`BoPhT@n+65}0<2Es~;aC?#DyIah z+?>$_cRqJ4S&Sb8?Y3g}Z_#Wr!N^n+vlW=N>OE1YSFRoqer!`utR8OK5Pht^OJLq* zkx@ZDsVQr9Qw>+QxVS!jO%mZuKNDX#hfxoQwKCtm2Uq2$3TD=vaA5Cq&GN-oS zn(dJue7(_$noG8ews5VZ3Cp3?1V8VcOS(;`1Iw``gbDrA4^@cpjlTVxQf_t_?4Yv=E-@L@vi;?7)xl zN2EU_wGiBqlN+gRamS~};zecDYPrF*KZ-__wmSFI_;E^lsX+)&?)vf9ovyFdYL(dQ z!VJwhuMe?e7>gi&)Zo>OIp@TQn~!4&FZ4{gQ?wpHzMUyFJA0iojiNL7cXVy}E)k0t zE(%p{Jvnph$u$+uMk!XY(3CUX@;a&OoS-tX2iwqcPR!n<9^Z1?NkFys`G`8=cd^oz71=H`Y$_*BQjr#8@BllBmP=8G;0e5Mw+!!@zJU zDJd^e!gqCPpy6%ME;9<7eUe`OUwu4vcA3ZoUD&qpW)e4N}NO4wI8z>50f?9u4Ol0>ol?CF?J4xl8+77*E(bu7MwPuL+;28 z%VY~=CwN*08@&$iLtJP&mYY0jj>~4pt!dHb5XLdOGElU+GdGAlZLSe6s8C1*a+T(E z)o6j0V_r{go1E zPX$vsLIjLp$>+)h5t4TOV&mE0pLie%8Z-=uUz_+{LW8zO7M(Q)S|Mif?A2wf{qcHaCkUC1(UI;qKlY#Tkzw!hoBEY+*Vp1#PeKKzx=^S3c7NN z$}(TpPrIGh%-4tX-slINRHjhQKg>DP&S;%do6K0WG&M6OhAjR2D+O{{=1nczFd`Kb zZ=+vU{SOxEk8iXH0ybI*b#Mw4W<5jDWf98)Va*Usg2r2(Pns%}>@V_-1=~l;(PNpn zY#aGogKTYUIu9eedvo}a^O2Fj*p{eARt_f8i=N5NNB;9Yo5uYDPimo_2AG!=Yvp{s zcXG{KW1;;?Vi?3&KZXA@1Pf*Ic586&7Bi-)?3y7=WXqgIsS++aF}7$b*4Qp&+Un+u zV>5(mqx}gQ?{y=wK!L*TXHiwfX|w53RZM|!+l2I|GRvOK z2QM1-m>pq1kReX#sX8|pk)|+8D>7T6Sj?G!BuM&jO&(7Btsrt}ZQM|aoSoWvE|Bnh z%3Oy5px701MzQ+oAyh} zEjMk5W=b<$wwB;lw@1oRwT{_XuRWnLjwp?>E*oi0A#j`56wbwXu%IC>6HHnaT#Efg zoTaDIqU2jgyk!?2x@3*!s1lK-dN-OwlYajit~b7CkwZsQB##YIB&yfny-2Vt|*M=;4j-ZrZ@-qRyJX{qE;op{^7ESq=Z9J~nes^4o=O3i`>SmYSqKr#T6Y3TteeGAF_A=@Vu` zLe2zsm~b2gPqFjX%o_iYdR^mI2v|VCsrBhxMhrVokJv%kfUWpp)q8ei?2;@{o}LD3 zi@mT}WQNg1zm4{kY!w$aue{djt)xD3w5weQK*K;I$_Yn7Vvx7SPh}S?Cd3~7{4++n zq1bpg2c#wVr-qBwn!RT0hy5%WebpF^S@ipl0{tvMU?i*hpN0Ab>H5M&H(ay{0=E8^ zQLs6q2;pd)5#^AcUqhMXC2#U86;oSJG`;t3+aSH)mh0N0_d$xW$9)mUm1(_ZP3dLp zy|pNH81Rh0yqx5K$>HG~rBGfg)*mR4TY0D-@+J%s)^X0?RGY2cP@&8{GMU(8zeKwu zz3_a1O>VSCigY$k;Ht3sqC$^#qsQkQ5pNU0>{+K5NspYD(kPToOKb3_X^V}a^;P|=?^m}NB`nCX@b7m=>+ryU9S-IfCUn%$Qyw}2*B6b5P+8##BRRBc5v;?3u ztPnYPn7m+dq!Pk1asW}BHedl?6VN+JzuClYegr8h*i-5`Z#;YYKCHvgzE>H!X9UgA z2-SkgOW5bR;R}v^E#JpBD&PH_NLljzGs>6Z4FOVP*A3~dMH8gu(;Tu9N6T1*BOfmD z#9n~>mrh-Cz^Y5&{&G(mVzR&RQ{FaKr3}Qwf>;2 zKJF;=F}_(KDA_DL`uw5Fxb#JwjAmq>%5j3JlO5s=0w^U;)X7aW%<8u;#Dpvql7S;~ zny?C9TwTTl!s_h`5e8P>P@WLov|d#t1xaJ5RAQS37G zy}^H{oL?*_T}`P1U4y4o@3N;<=V+JE8F5AmuT#@3DoBz(#kbss3|!H+7RL7)hEA2i!qrgWhSpCSV>UFMyD*ku23q!XO5TrL|YZI6SC=;Roj1S5sX3lV>B za#GQ}2taY^3g^blkh#u?g1ag+q7)VdBsAya;2hGYbh-`MH}V?9)*qfKs^lk%PC6#z zN~#PiivErlA3v79ctTTC&IL^#lG*}nqfv3zF6*Jy+B*uZjjw$O9@aijz4#O}Qc}c{ z(E(*kNl!z6C~2{!B>UPua$QHW8u7b|F2Gmvx(#8Rl*Mu3?lrN#N$wU4h~V1>HdUo97ff?`z}Xg{B0nf$C_A9QQWThLm*PAmJ3wLzQ}LkBt(7IU3N(M zW8|L^R63>D^3Ci*1<;G0nbzfU2OfGW;$+%F%E7ZpNEwQdA#V*b{!R~Vl!P}z#^2}~ zjEvv0P0l&m^)Gk0kgcI02v**hR&pkjPhG%@q}r(T1z%Wwe6M_%mOa+15wZ=D z?{KxscNorgI_W_mB)=4K-AIfp;MYlQY8YnjYM!jgaM(QoGOSsO(8M{tsUl%vwn)9v zoZ}B!8mq8^aPG%BJ}Tv%`L%L;*&jy;IPJZKx5L}_5~r-f?YCFdIi+-DME`OyE3aJVtmEr^;ACu9UP@XI|qs(Bk zfi3CSCxbKa_?*94q<4GWq*6ZU+Yu_|f#aA7nmmWjY;E?$#l|fK*x99qSmI`2E6_Bj?MTBNgQEH_JeD`sk)U%sLwfd@Ao zPD{BztT8103v<#G4y%*HQ52fs-&XC%3bhNqg=KUpx=3eDQGe`9oZ18&S&$URVYt04 zg7a~UM+!zNn-LqrX#eAF_NGftkV`>TbIuX@+OJVa8oQoWCkb$~A$9VnxnWofC*EB$ z`Gh9cDwj_z`K{$k&1TH5Olm}1?M*btD^!d2R#}o@qCl+|qBo1?PmRTWDg^WAIb`KR zFxhUo36Ry4B53}hrq+8lO0B=h0bo(j#}dq0NPum7DTg6Z`Y{g_iu;(OB1TT4J zMg-`djYYwcMi^8%i|9mdU9LnXh|Nl5Vv06LP;AR}9_WMf9`fFXB|d$m*09$`4!$uK zDM=2#rfaYqd_E@!-+L5l4;c-@le&SJ8Hb~*XpUIn#nNDoulZbaXI|Y4qW0X>9Bdgz zo{Cuh2lq?q5C?~fGhaluyLAk@kPvkSDXmc=p@nisNgb2It}u&nQ>y88p;FRVZ1Al1 z2`PZZ%ROry!CNYm1y{qxa$S0Y)qmd2S~iMYh&D*N6`h zA#v8?nx7^~cgWU7`2vL-1hBtNXCNpM&jTUycI6T$r3kqytKbyQ%p>;Kdt&R}EZ zr;Y_S2YSBwc|n22Yu6WK%{t?ABw3v))Gwc&k*rdWEUUD@taXw+i8XHw@&z`70A(XL zX$u#nlk(YKF^rN{Kd&pt&gWG;UMFitvLd%ihL1+grW z$M~L#kxv5t5p~S@+6M9m0((G{eIRhbSbsSeU78|k6@jH5o95w3-sXK?SJG7@Ct*s9Q3G3<#Zp2;A+ zW`uSvCG`u1QCWGV`wHDF^6ilDSgrhWp_PI$7(vw$9Bdp8tCP~#9i<^h5%AH}-`9tc zxzfBG{eoIUru=W4_fjaUcUJ85|Tsa>X|%9Y?rUFONO&=nFM>ZB<-a+M@>iXubKN;4$$lA#L+K49jZ8NayAXFYm6Wvb@z-PF zL&Y1ul>;&#KfGdo-%H#Wo$-x-Fj$JyvpHjRndag;#V5M&WUd&)_P*rCssUfO?o?=j+h%8_-ZkOIc4D8F4iu<9Qv)W5hzqaN9!-N}aJxna=gj^aQ@ zvv=Ri@s+8Q9Tpsfg?Z+ns)!|u9rcNo-6+eg&uJ)EGM&N<#p-aH4ogHPfIfu~69kGm zgOTXyI&;v6)j8L}6wa=rVmrk;1wgh6qVrSXFG8mBrPD}_V5D)244q`SX7Af`dZl8{RpKWC+0$meP^=CMa;u+=ynvN zy-B{{E5${___0fLQ%BoN_$jZ+toP#%e(k|sHFa8Kp||L60&wAG(d@DXm6v1&fwllGaMDw(LX1$1Kx!IxWYAP{X`X-$R=7|qrZsm_Tm&unyRA&Zl&zv z$z&SiUJ8PH@N~8}2;l?QamO`|!wMG%*M9y}D*RAeJBC5O%sPs6!3z<0rswm=O8Rqh8|mTTvZ%f}qrX?*amsUfr(A zT+&SII3tstSfJO(16+@S=*Kc4NzU?_`79KZptk;UrlE7MK!Q}hj;V2dOj z(g6xnYb}s`SL`n9pJ34gBvs&?a1o5yfxngxPVc`y+uQSc<^psY%x-$pZ~;3BNA?Pp zPKn2y#f$R-IE#0X9i);B07}-82}h}Vd=-kFlR+m^7 zSJc-6FJ0h1Aojc^cm^DcjA2MoEA?!!oT z$WRZmZMd5R?7lncA_P-^TOV?r08y9oZ}GFvYd&}k)E>d~67YcVLf(L7Mj>i1^?QR= zuttRQkFZuR^}s5)Cu#=a0(d|vhRaA*B>hIA9A9jR&UoKAK}K2$JcHO#3nILNb54EF zOVP{)jc=?ojTkq1S}E;`+z)s3C!AA5Nd5T+ln3D1Ke$&?G)++@(WhPu01|j zvo1Gj)94NWD6m!vtqQimZWX=>@v_`gT3zMGXl+6NpnI@`7C+xX55@QC_MH&&_G{_m zN@Rt$ub_{w)5pKk$1;upY^U_Gfc)NelRo~IetwQVzC$11rjMJq;^QQJyp@VPMjx-m zx>Nf$`uHpQ`Iq!@GyObCA5-*kIeq*-ef%DMe3d@FLLVKtyX}BJ<_NT#@zKvF32xft zLZc9nuQJrD4Dl*MyULKRGL%mgT=Pw8=MjfJ>R5T zg2@DOwtLh;aoG6{z|#%)-8lNB8L+f`4E z_c0-EEVt$qNAK$6)HL{d9uDTGZxra@V-oo6|2gMsan8!sdZt{xSdFhd`D>!iSDt)- z&2pbVM_e`X<(^e|tDhx7DDl^rsoZQr`XgJiZ6q&HRrj2^`+jl?kct9R3?oI#%Y(;4 z8SS4TILv`Fa{tW|I?6877E|GlNx4fuW?i*QPJW;p7fDT3T4dCv{i6}~8@2xfN$DBX diff --git a/docs/build/doctrees/how-to/index.doctree b/docs/build/doctrees/contributing/installation.doctree similarity index 50% rename from docs/build/doctrees/how-to/index.doctree rename to docs/build/doctrees/contributing/installation.doctree index af365f98bced6fc5fac1dcde2ec9e159e5ec9fed..ecbcd01933263df13d23ee12d7b2d6c5d180bc5f 100644 GIT binary patch delta 148 zcmZ1{dR>6Efpw}6$3#|-iI3g6d)SKeON)|Ir}Sh_c4qX^OwP|MDauSLEy>JF*U!u= zE=kPENi50C&(kX^E}2r=!(Nh@o|l-LI%RS$a|lNdYe{BFPU@7+hnZ(GGMa9VWi?`C z6x%$3Z4Hx94<|@nNo7H5@s!#r8Qir~Hpg&!GYa-_#;4>bm*%GCl}yQCE=|${00kQ7RqHldUz)OH~ELXQTAo=hOnP*&PaMj-8q)h>1pLCv9s zz+OzYhn{-qwe;eT>Bscakt|&GFs!sQ^X9!b`}@(a9ru&_^+&LDC&fc5BCX;iA9F!j zZjGO_NX3HNdwXWqfL-XrGibw}`LO(c zT7a03lsJw#Ws9-Q5%>ADr9))UjYOIW&1r+>S^#VzqKK4aO$BxCMXB@vHN3=lh4C8W z2xHguo5Ro`BwolEy}CfoJ9UyRNSY<=Qm@VXVu|U;JW4cWmvK@R!#iTSDOpgKDX>$= z_z}q}t5Nz@B0_s-Jcub}9KRma-J6Rp*J;QkqjtJgn4sE3E_iZ{#epPqq*b%h@CHs` z4~A$;2c0`cN1-Xu3~C=nb4jv{NlTiV%l^?n$4eYs3fn*!kE~T=TWuE-$9JFv-qgmG zAOV83*K4cD;D-Ju(ww?^2r$In`)y~|g25_tzBx{@3fd=*GhDsx{A}&RIh^IDSH28& couRci7S8W-IKcA^`uXaQH+B4StPaP20auU}0ssI2 diff --git a/docs/build/doctrees/contributing/pull_request.doctree b/docs/build/doctrees/contributing/pull_request.doctree new file mode 100644 index 0000000000000000000000000000000000000000..ae973e2a6a937b4b0f7f06606a7fb6f175d317e0 GIT binary patch literal 9568 zcmdT~TaO$^6<%NVGGp(0?Ig|xn{@2hSudU$D*_ZYQ6z{IKu*?CaFCE<+CAMhQ?=W- zbXD)}AVmU+C|Ri_E@|F*B@a9jAs+Y(KwgkQ`~!XfhzGt?)wdbE>vc#h#gbRk)m5je z&N<(?_K)X(_12X+^G~0VDHrix-wT2`379POQjqw0#9~!^SX}!_@ourEJDImDlRWcT zq31Be=OPR;78iH$a)stA5z2l^U_p7=m^I7!ynd?RcicB}iLJ)pjDt7wFnp7}lQXF{ z3ch%!&|OcdObl~{6VQ$)L?A(3FZ!V;B?j?(KK3H}YbnUn=3(gh+Zh|#Irt%hLO+(; z&Ad2Bu~}v}D{{T4yfG~;cvqhcMa+tu$Miz#;Wnz^Cv?ZHuaBpN>egcLmSmY6jKfLn zDJce-^aoy#3*~bzw(+Vr&PBj_D(U%2Z0~~0(sPosxMv9sKwJ*m69#lVw>)1zld8yv zyrUN-^OZ>AS_XWcFA%5J@N!-W6|&YVJ@|UxDcS3&#QC;RJRdr^ymJei;~b8M_hIOi zTsKSyrIWYW9trBf3A|Sr)!+{Q3V(*5;FmV})0_Fwe26E=EXj*1b_4e_WU@<59J{Wsylm8 zxFJ)ItlUzXF#vvt8NGeGyvyn4F058`eWA29=8RTN3HG=RKv;Mc5bAj?4ItUq^IAZ8 zb_OV6BU> zC4m?T7C2MtZ8iRGD5TmIKf3FrS+WJ|*LQBktP3>(uqFh85+qRyFOgk0Tuh)AnUlu> z{+id7<@5a{k3r&li8B(gss@X@A`H7m!OYx>^gT~ifpV7M?F8V)-T--)$6W*FB#K~a zOLVRQp5OS?TxenK{kBYCtIrs#4_7f_a8^*#%00usc53cb=vXY-*&_IhHo?OU_0J&W z_aWFD`uAU0akOqe#mWY`6*Ai{sxn*WDm4ce?$qjibeluI8tgmzg4#&^<}f40LmrVQ ztt`^xtz$MQ{1>^0UFPh1u_6-_F$82Svm>2RmPGeL49zB;jy%|3i_)%jLL;ZvvA)xw z;JQQM%}jVPJt6jX#Mo2DcY}5}V`(CVO0ovkvnV6{NS@>&Oa)`0zCnlBxcf>HQK)7j z8;WPTWju4&LFlNG*g8mp;9H*y3tBq$aT`ti=e3F)35tJgFTOt%KQ>U5(`vRgE5OuCAtJ=w8zZ(~AdLJO*sz>is@0=$ zc~kN`noW4J1vW(CBBH%oR`@w&Ic9KU!x^|zc}n;Q_KnKARzdq|JnmX1926+)6L}^I z{nWt(kS_UfI3fV3C|%OW)(ie`Nq7Edb;L4ac{(39chl!dXDBQ2dX#qbsAxgFF&UDZ{01 zm5CZo^(#(&k&fKR?eSU)M@bYbFMOFhwfv^!wn-iWAaMLpAcX?YY$TQ;Y)=zl1Nv6_ zjDRT*)rrbQkcTrqC5HPkp{Hb)x8yc1AAxRTqPDKg+=~CD_5){Twy(suSe~avr8h%m z#v%OUzGlvx!}y2`rKP*~EgNyn9=tIUhXqB?9VCwTHz{mD5E^ zriItF+6O(P-5Ndp>8DbG=MUo69pm;*7GGEEOku!!5ft5U=`tzV<-+Hs8M6_9uqBB+ zr2veS8%2dCR%&$o?ay73EcwLQx zUq2uUUYI_5gMvR86pTddg;cljq0EGCc$xzPP$v>&uHb`G2LC0LWFbPmIOwt+v;=Zf zd?Kx&bh9d-TWuIJ2S%P!>j2(~%$;>lrcfzvnD; z>fSB*MNDX4yShWQZ{3CCmno+^rdRwNaek~^Tc9d7_33KFbo4g$l4MGOLuhB7t=p5R zdBqAHm_jdn-wV-vY~rm>6kTAc1j#Si5f(Bt z;_gCpZq*0Hj^%=~F^bDmK`m2m2#XaKH;?Ns_rm&dUY})q0=z;wBA3;qc|9MnVLrxo zD@aYLD1aFm^CFCNRE8!9U8?v%uZS4Ywu_20iuZ_dbthM&-U~e`@cY8_OP6I?lDRN| zLC7-jnU3nKLZ3-;HBDvSP$~4qnKv^ewib@h&FK|Ow>d+#`oi>!nZfOyu>u6YtWV=I5)d%81595or@1B$r*`^z`h`u<=AudrBuvx- zi2M}V{q-YM^emwYniG$qh#}%aRlL6XoL)&;+Q6PJbDBnm9?nkS&`)rsQn@i0U|9Ck ziQ-AzPqOi#fUUtya{$bA6^kGqW%_O`?OnO?Rq%5q8~HQjX`~^4wIUC&dZe;w!}kSK zBeMr!Kj10~u~|oXL!c;7ytuifFG43Hw}xlkPjPMQZ(py~Y`8folmyJz}2iqifnp7zS%Eq6>)gK=2lC;Id&MR&VENv2VVau~1x9S#pP(^`K3c#UU`%Q^kDT_TUZj_HY|VO$i(7w#)7bhec@D|b ztrPS#M}Iz{KYzlXTz6=hnxtkEyYK_EZlBA2vt-{)-_Q9u`XJ#VziKI7l0dbzC-=H$!1pb9Roh*R4U!hJQ*vZ6g==Ry2XplFzcwT_vokIoF%vpZ81JJqgc z(YY!5rqoD2fqXL3PseJHbEynS;2$VsDvQgP zsNf1$i5R?WZ3g`^phP5=zyTbVAyY{38s>$Vci8tQdcO3J$Mi{39Dw?}o3Gv?CuP5E og3+u#2%^f$mZhgp)f_R1I8}!AK;W35-VMlglvb7kqkP!^FPd4XvH$=8 literal 0 HcmV?d00001 diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle index 499254dfc28d667c345fef8d403312593943e698..137cd5d8b181ea5e818d41f7fba13261f9ec9b68 100644 GIT binary patch literal 27975 zcmc&-du%0FdEfP}-|Oe@de_-axXI?>gxH1zD1tzDvzu&?6DMSo(nprb+NO!JKy=vcfQwo?7O=^d{2EJ|5M{p)AfSOGfuGVg^i%@1aV7^ z-kW%}>U}xThg!Ek)4I}{QU~m2vo)^YDx}^ifOo zL}7({ncKx)fEI)-c#ADHq#0nod(KKhI^zDuvJ-|NKLP_(cjUwgbHKSAJ3-_%f~a+| zrA`<=UXEw%ByL1bB}Q4zE<3fBt$Leb!w0CPdTU-3uXsTn)WN7tlNIdd*$0 zyR$U!Ej4ORY?tnvDV^8cyt8z{Dce!(*+J=ECj`ko=)i4&@i%X;esAd196NGA{cC1k zGxOS(8jhWMvu4LmWHs&Br2!0BDGc7<2he;()P#j~vT9FzGk~-$yT4;oIJ7$sY z)pG?NToA0KTS)Lw4Gl44_j`*o4C;>Uat)Ba$LKeM1}Y5*cDdH5ETR2_m|F-ol_cs2 z52Wd!qnZ~iMV1E{YpDbO^0UtX`?6h2Sfr-h3HO*ffCbo^f41db=bmuS;tw^ZMaIgB z$v%vYuyW1g?xgzw)$E0Uk|4I+^W4-u>0U25y5mOGUNvyl&!5&pJ#NiQg}#~{EGG6M z2G!*N0rxzJ(bzS|!m{H@>Xq-PWlQ;S;f!V4@^l6^NyWs|VWSaWnR(ijU3nUOzoHSB z79B{_<=C=owZ@9IkUaI&suhQJ5J47sC9SDmU5AFK2I>%eC$yjrAiQ2sbuMdEebf)b z-6xqUcgDR-$Q#k(;slr*%m!9k5-&`@aXRuArL}vbdy~{XRCN~Yq!wEt)}3L>al2Xt zaRIMj2yzIe=sFQ*>p5vPN)_sjY62$FxYL5`q1)<^twtO)V#f-d1xRL4ajd9mSDe*Pt=M4zPNl?*MM<-X)e~hU7jY!624ej2?mK&M~e1e|RW#k@{ z`hyJ9h7&55D+)noEG_qffW=OscbIC|30tPRwqL2$hW=$VBa9m!LJ)fk9vZ0LBv=X> zD^RFhK{}5rY&qRO7hoT^f?w1EgvDFvu8_acx;+nK@5z8Pb)l15Q7vJNui2pWq|GZA zxKr-!(xdRqSoXF`N>~v$Dq4OI2vVV(z;Jr>0!^z%uuS0aa=w440t?F*%g#vn5vHqd zYq+)IRcV3jlU6bsR)|=pWOls())Hu$b5aa(wnX_qC*V=W374!AdaUt?hulC)U}(k5 zgqLJW#<YK*>HDN55;Pq#JAQGEXu`NV7nXR0`KGN$J*%vH~Lym2jRdkDe9sb*rMZ zKvp(sGE_2GmYC7L<wwpcX4Q zE3xZCM{+o(-t5M4GkVkPY^55^_)*oVdCTEU;KZ{*vp%cqp1yn5iC#a8iI}d}Ytt1X z43#y<*x?|I>lrd^y3&f4taaBDQ}DB%xV_~F`Dx>-7a>kuWs~0Z#7|MBi>6YF2+}}4 zik=PA_AWSxo5Am14>v)977Yl+MY8at22RljX%SO!$P^@GJlCZ5xB*h|ZLyX>eKxDt zrA3)KitP|ka#f_xF;k~Tdd`F-6k|``|M-IsmgdhqbYJP7`yM*;wg*q2Id|^S`z~B~ zYfE}Qnl+VB3W2m;hsJvF%>4Ps&zwiQ2Om6L^JW_1qG@x8V(-gXDT`$4R9~|S7Z?!n zK1Za~7z}o(+$YtbwkI=GF_%Y}%4GqbIQ{gMYh@1Ll_jusam(fvFd#jN-C)S5K#=8u z*s@yIUhfGhAoV1F)e$zqw$ze(pq*(=H&wX|rEYxeNvR(?iEG{YLnQs9`2pB01L)ux>BG%!-&&76gAaU>l{z z;RupjbHsugzsH}1w21B;!}9ckg$5-j*x@tlH>C?P$qE1O&_KQF;lL?jtWGKC%a$4o zr8HeQ^pF=-oEl;jFg{8b?zrh><3b%ZMH{5w6l}WCQnE9Ss6La)5aB&)5Cj+;vXov8 zt1HoLIc^FoVFP)CH1%O-p76(psTG%;Mb&%9Tc+Q2)2pAx!8qkEVYD|Z z8?9L4AulSx@0koGJ4fvyd!pVcf>8Gg(r(xc|r3=~}^d8BItIjedddSmI-Po1Da!acn&#LL}Ou|C#e{EK6 zIIAXMSBfCl&r%tph~y#d1{e)BEs6QG`e=p-)j5HcmgP`|PMz|M?d8X^wvwnbDtIkL zF_~4VdjTAlux{1hjlf`JtjTdMg7Fr4cQ2$!ax_YU7zvcLa3t$N2eyZdGJXJ)ma*(a zR*{@)5)Ld(N~K_}X2j$sAgv~8!;2ZNi3}Hy9HE5x(<8G<6wa2tVAl1p^;FB6 zl{RB(8&iDFUzqRS)%`crFPOYI?>XREPB1I(0CrMc*Nm&g^2*F!OSdMf1pAQUt&7@X?)?=5j^?Xux=P19cH}_`5Q;23Nt+_6BT(dO=y4X9ywn$9# za%_E}rxRT$GkeTwLu?_>^`t2s0~X$({^UAbzP)TqrjN)tysnhOS%M#32NzS)nme$e zf7%>GgY{%Zah1S5f~Ph2Mr`3}EsvR`s8zCAtu-~?21iB%TL;*>(j$Shulm3jN;Hyx zJ*9>@DuutHH%n9(jF1}QL@5lYE!$KFY3(BLb+AbQKZmw~kbee$*VNGpYAsm~c0_6x zydc_}fzR@sI@HAW4dp1<2q+|WByj+6G$Smaz;hN`tyDATmd&d};X)04KLX?!-p<~9+j-1+p zUFT4F7O`i^6PEk|*aLa2snduX=kEvxj`I zdqExI2A0_fNmL)!FexXVC_jN)aQ@79KKK2rmlkjHSJSWXvse9<^eg)2t^VcoE4luk z{4o7m?s~$1D*O8SxBWQ%TKUWq{?qB#<<&3vQTnyI?_>UQ_T{W33Y(J@g(IIv(U?1{ z2KBxl0(08xmMs@Z8J7A1T8AHMy|?vfYl^8Mea6{Q1nEYV%`{0PrBKKe?fNnFc_xe+ zUB|i=jW{1eURn~zjX-LFUtYi`1F9|m*FdiS>-a&vsv+dK$aA%8EB0#C`XI=wBS;`& z(p5i$s_LL7p4;@WEM%-_sUZU$%>?8OK=*PD+Six!C;g$lq7$#s`h8HcH7tez-n;)* zM*kQLG4bZeT{ES#Ac*(l?UHC@@Q2W-9@*4w`7fbORJPSXE)bvvd%$Dg9{xK;?;r$c z6}rVx;IBUHhGZY)#d7Z9A~yYdV;kNrjHdrJpiasxL;j2STL$2N9e=v#{cqqGX#N&{ zshjTxsX5D2iW?NMPw*S$`hSYw!1ibI>o4TjU&^n);$MmX z*Z6ISB2nIgs2g6tjwri?$gE_x#Wg2|oPPkiosdIoX$x{DUblf9HiCJs{QC~cphdg| z8MnN4rgXpf1tmMEmd?r&;_1Q`L?iMzQ;?^s>%h*KL&~HhRZ}8C#~wn)qGac!s1cA9 zwawB96C%rGM3iu<#M1@F@~Qft)b8h#tu{$bQyBRH9xpn;2{eSc<-=b%Q%2?w=MqGu zh}fj;6qayOx*fSDOdGf-z&fK{x3{+OX{P9S^ol19zeU%xZwOZ*>?V08I{pKCgM>b~*`fhoLQ-k_;?Fw@YnFO;?-k`=rnkOZ6vduTK|iksvRG|w?>o3h zN<H>Z)nFz6UqSXqZ$f)>eQJK+(isQ*nYPF+QEo`V> zPHcL5m!yk^xRr@|OHp~qR_~h_#Vcu|&gpGxvQn#v#WoM|t-WF+Ocb(jyirb8iYS;) zlMEXc?Groa@J|#)ku8@WlS$fj6ZII<`q!R@_w3m;Oq`;8$~LCpXNvMK6Y`%fiem4l zU~4boQ+qfC+w>AXQIvn#6nv~Giano#4qn2y_KfY<^b)>NlusF}Un+`XJ*x|t_{>WX z!%_f6M#Ya59fCtzc8lf^wh_4AyN6S-O_TJaMfsNr_dP{X?D-UQFiFmy zvHhARsa%v#8LO?LDAu#OfIZ1fl4!F6C^9Pkv#3thCW*KFUOAIgVEgceT@o@H=~fo% zqeaCcldNB66tAF#nlRh3v}4|33-&8}#Y1)M6b`pgf|s*;x$ZYau3y?YZ@*X+MYdkP zAk(wkk?X`Z_QAiqhm)XBvTQjCe_ND;nSg(%D2nxyP(bfxs#BI(0TdY(t)c_bs*}$p zyb`MO<(zRi)D|+@6_#9VJWiM{YJf$Z!KUE^w-b4l?++;>Wyy8~@}zNTTKC z9bwpfzmpifmF7OeeH9=*6YMcY(NS~zO^gi3o8)1hPCLfiKaiB2!Q%1t;`AZtv;zYO$zXr0POhdN^IWVH+LqwMGy(zD>;ZtVTjn72}IKUZ|N zGWGThqv)vKc7N~xWO~30j;ZYTW@o+HHb6hUSDaMWpK8h}v)raLy}Gu@2hLg>oYYV5 zoX;OGiX!t&UXZEkB<@8MDHGc`Tleifn~Gzn=v4=b6zplbbTMr%U2K?yZx-cXChUJ$ z6vduT!bzM|r7bQT(QLLYk0!A;ho1y~?pvb6rSJ8oJ3&)2~J6X8hSHcAjvfkXgJ9dpmx|LnK5q%Z% zg)+&yp(u)MPERn3j*08S?!}lqlZfl=bi0AC=jBhm-M?3iR^zAmQK0F@0>3xPJ#Sdm zXNxi}~0|iCY#;++dLwvVFZ4FAOBC$ z$K$&heeeasT);6Q0msFn6P+nendluU&Mg*MQKtrH;`x~tzC6HE-)==efWhyEm%c%p zsl%thZ+anS8W&-vb=MnK+53tzKU-zb6-BXL!xfl6ZMFDvLdRvk+m7m1_Z+^wOLI!2 z+R8%xUQy;}^Y=SNQDpP?xuPg!{t`8UycNB^iL0ZMW};hjblG!mKcBLnJIEJ1=DPV- z2fk>#WbOdp=Rg&T_UGg#2g+zIpp4izw?9$Cggf^t3GNp%2ybFZR)#K^4fysu3@G)XCRbQ~g%%BB>g(Y&>{yHoIDimk4_0Z9$qf zcWw^XcKRixr)#$~oL>EzmiJZ64R{n&6SU9}mWLtpMK`GllBffCJB5(>{{@Eo?*=dY zAKx3!h3auuNPfok@Vt%0v=V)xO|Xr_vdO1xprjXQXJ2& zv?W^Bn3Of9WQ_?~V>;HDj5VfWjfq%e8rGPEwS?!=eSg-0Kf{#B93P;U0 zYO4{vw3d4y+d+x{ECx$&WCu=&cidDr%s*ZiigB&kKaVzC?ms|(y$wH}ZC!1Z@pecb zUHsshpn8?#UH*bcdLODyt!t|eJ;d`+>WuyEIqW_9txEqL0Cqw-c!A$%EIopk+BT*4 z$8#9li1gpdXw~6I_;H|88*La|fA-pj+zrbCI$Q%sE4r^%*>FEx5R91u`w z^N(!sLjo*|Y9oA`7rj9o-3ZU4rNrUJ8{yK=jrod{+@p&==18@Eon(7A%+c|rxh}-r zk<_FYmZZ0|0(a9^L0#jv6Hp(`P7>uW;P7J27v@rxXteoxT%d#g#nmdl+94=%0F^ti zgQ{)Mx};~zSyyx@Q(N6I09LA!XMJhi1$n`LB3}jKggf-v@%HU>Gij!hvS#h)^QDJ; zg>}d0)#SPCX#KjzG$Z=N_qq~2Bby%wR~=3S0$rQH^Jbc0+6Y&jj%ET273Fybw&rlr z^FQeeJzysnT?<{WKA$0GNu{4^n@4d#5!KXKILgw84OobCCqCHTsGH1r5DJPq97}i^ zeNUK<*PU*W&P*vUnH(vq)1esR?={Icr5iDx-Tb8kU@XydiI}ErYUJ^O+#3SC#d`zQ z!<^;ok-nle%>N;;pn(S>c0?WCsVT8_LcOOj*wyM*wYLt?$ElSKuNK_4;mrbe|I|&oYEJ&9 zqxDvEo5^GJJjUq{dbpE>oAZs*j}){eBGo2oQJ_FBZ$lzSaF~*Oo<(hz_Yo}Ft7Ikl ze*@UnZGVSM{y!#ky2*FW`8%J4-_pZ5IlMZTJL z*zjf37y0LY8Gixbq<{qhcm$v@!uJJGPXU1dE~S7_00{y3F2S+@R#U)J0=Pl|zLWSa z0X&le-XnnbrhuygSR()<{dobrKLvb10Kbp|eo+7)CIBBG{Urf>Bn5m_057C~UlG8s zrhrcf;8O%3?dX460G}ZM9|QQT0DdC{{H6dtmjXU7fZt64UlhQXQoxr5@cRUy(98b= z0lb(3UJ}4JQouI_@NEKc+Ut)Pz>yMOW5P?3BoYYSdh~zupa%5|6a28E8oeKH)YG#J zj|bkRbMjCXa^O?`Z=rw68xY5ySA*KH@v~A8jNfiA)keyceqNUnW1gqjTXrI(C8p`yw`aP0`gULU zV?2{!v@5jP3_2o#ZG`y2N+5m#e|TxxELyVrhXwIi1q1>uD|Quugm`EdiI-T!S5@b9 z_Z@p;?~TVl=60Vtr%s)!I#qS5PW$5nKR&py#u^*7?s&FsdxrN#x#t|uDT+@_soz8y7Q za1+opXy=(1gR>9cTmPZN4P85RLEe)~PcA)GsL9N2cS1XJQ>$ZV9#J@Im2HKsrrj+k z%v&yjGdGb%jCxr+v@*|a1J$%J#!9kQ*~IWPvoqf*@eWzi0Hl*{CvRF#np$gq2!3JK zNgmSGG{H?lt)ra0Y=CshWuLHUw*}#Yx-FSZ9Y)!37>%lc&Zbq*>^OfsojFe|?FY1~R)DqGk9c z`sJokCx+%W!`Rut_=}J&G?yT`I>HO-xR@yPqm9(^p+tr1|F@s|1h8+~Va__U;2rhm zR6llDvHGdPJK>%5UciHz(JEur)Z_rxMp(J$G4Hr{fqD)>14+{g?>rCn9`H^Hj)5$0 z+1sXFjqt0r*3ODm=`bAH(RyyLV^MuB5b(@nSdAUJ7WS1Wue_&)E%4*Q8Ow}iaYi<2 z#oTL29A~$dUNf*;uYvEkG~&j(3vJrUEISP2o7P(X>Z{vUme^4WU1VwQs3F~lmZ(PC zP<%JBu-~D)e$;ZeG^$~mhub}isqz-Rr-ZyItuAf^*+3fDX?eD`_|e7GUzgEd!+S{j zjn;Hg!g#fzTX7b} znQJBP8ZLNmCE2mrb0S#>vk1I+@oL`(>MHVcE`lFc2XbiIUwAxTae3 zVy5a7cZ83ckDN&Rm5>rsr&eqF{M>28J~*P(eDI4CB>2=1`9D6k@UvRZBj26g2i&*weseMBan zg0=B1bZA1Iq5fv{47a;Cz(iw{G^t}|1a_O@&1e>;7IwS8wr!fmsL6qLC0S}#Ihw=a zT39>0wZWExr`e4hYFTo6w$^6ZtnDyQH_p16-AC$h?GVVzEvON*z1cqW1vaevFuP`0 zBJc@;0Jslh#a7qNg$EOC|KZDAHWuET$cbBx3A^z8uns*AQM*_H?je51d&hf+q&r)+ zSv93+*r>q#4BNo|_b=yY^qD*M|LNG*gTl zAwZP*Yd!|3p*-4%;+rt2+(9N!9rm2wyV5w!qY(HMXkqmhx*ZBAipT0r93Gh_O}dV%7oXHrr)9sazG}K)v!UtHYK;~NAQ+F%bXK1)Y%f_|AsVAGfu=@ zPU5r0BOdYqfxyv97>Ov!KxTN%&BP}UP1YOkY7}9V|0+7$p-kv~$eY&&lf5@9orz@x zFk1uEG*675z*zIt13J=caM0C&vCGN8v!~O>a+>>N^+{%B_dH7Cur4<-!iZpCV{CXP zWt>~q>`jh3q|tlKdz_)(hrK7{;bHF)=|9E&VMY_Xd%Z^mH5{>(cUp)U;Tt)C;AtdU zOQHNt8(SZKhnr;(+$6XiM|KF5q!I>vm~o1MC&~H_TO}SUF!Hcf=v1g9Iu18RW{EHq z>M%u@h{a%`JBbxHImYJLyuPX$qBmsO&v`#29V7s)D;N`@1=9)rOl#hb^cMhyWR`>( z*cCiNqCHk*0Z`0mfOEXws=W+l4=rT~O9g{0oJgTlPwLu<<5B2VBZ&5_8LQ z0D_JQsv<~D>~W!o!VsAUW836(4Z)>iqJwx_JyO()_7_y8l&35{&a+Mq=U>KM0~~kh z<;lK5(11_~!3-j0azwm1(H3!_yyQlVJ4B}NNmRYH@clDnb+!U*CNvyP&E4*F??8^tDS^S&u7l3CeFUvaV_bo3wt!ODoTW;uYCQFfze1 zrV%baw%AIbKfBeFC8#n-nVq1OLKW$A%=8J#&Y2?#ov}}xfBE9Y#_H)y=Ndn7?$YTO zFFt?z?Afd5u3dYskeQEGL**!igS6d-#kzQU^}@@iFJRooi_eGtQk<-tG2?Xh-oj2< zCs(J2J1vC3Xp!i1N}$GJa6si*YE1i+CF)qqBP`Ui0Ixj%+O7A?9JK8yhp)>Dn|Hvd z%p`t;Tc)K2X&k66n`IsKJ|F-xPx92pu?fB<%-fL;rZwHvWeY~##MmdKe-?K_che1F zaX8eZlbM9@N2J4Ucfj;$oV5UuC6eF0h$8H(1A*k=hOXRU=Rm78@o;%2o?;$ z1ZZ{n^Wa(^K0w22A+g~n;Ac6(WQB)COH{=6$8|FUyj@c z*6KEDv1}t=Yn182iA#R!xFOCcV0>C`+*vcp?HhI4fNs-%1GwWxE6J`nqJ~W-LzMTZ zK@eea$Wr#p!YPF7n;Tq04CW#zef%CY>Gh3qD$n=zen z1+$d9gwwtgY}&CTLf&wrxudE9-&i_A5n~@ zhAG#8tRzmz6OtXZU?XsXN7f?q5^PM1Q*Q9IO#Y;!GiF$VwfT%WSsiycJ!2sWW9)(M zpgrF)r_+(}_4Z^9Bc9<7cVxp60=*9-07VFtuY=Nf1Bb&M1XW~|X_x?5ktj`XU?-4` z^*a{QaHs(SJM$e!)owwAFMm*JyL;N?j|LADAG^^C_7-gmEDe4-Sl)O zVWAE_Rdt)Jy2-JtL{OV&qX|_+@{pGQ zVKt=2tP-z`nJLE@KsBmSO@s)U51_CMsFUENn_=T44kT?usSo<42OPSh zOJ`-t&D8w75lZ^2Vem+@@NeQMGmE*zro&Ayvl^78gSS9kSuCMErY>SFiAPMAoMNR< z9oH0;jUH+wNdITFlw-SrzE0=>W{RcdK-5B42FuiiX%?E$|HLj_fxT%pwv*CfxdgZ!h7+7lm(5IUJ(>L?eE)V2re7PqJa~ zon_7dP+X8_SsX2OsCLI0J{&Zcp&3-8+SLl4ZMYkE zMiTp`P7A`k4Lcq#D97gPpc(^W6Y(^RR9lWW{t&_xPKh8HcEk60d=>zO|Rm{MTN9Z|?=*Ejat4WJViy)M{|`DeW?I7r~5u*>CFb zJYq*m$}VE+MLo5wKA6O;vg{Xo6h?5gL~*`X6z575!u;=CjKOm}w;1m|xBFf)T?l#< zYHuEG3$)fn{WT~KOzYpv&o|`fJ^A?u{<*VhrPvBiol~V@OA=rzpy>fN#yo6^Q7@$NOr#@#=C9aWm{lb3nP#v4s(cvQElEvEenlTk` zix1A*pY0XJH%sySjELvH3*n4J&hICLxA##9I&i>5H_Sw8Czf8`WKg@AAIs!|{2)Hb0DCIsa|iaIsf8RNL)EMzQC1yZ@op ziL=^-5OcS2+PgD<<9*}r$$4YMXv+}=@5ABngLByL6-A}#Ya*okZTgPBg!>flFNUAn zH!;l3(-r!A5W$eHX~wWt53XAa>&l^6ibQa{a7J z6hj016?Y$-r@Pc-9qq*qrbiZlZ@(3{3E>cE_<#}N!Cq19yAV#HUPCfKA|I)cq)`u! zyOWoX@0%zdoX52~l7uE=v73n71oCLF+^lxR!@Z)|Es!3ZP35m7>(&E`ii)_`^B_?{ zMY1VWM(FD^l$52Af%+R4bXNK})4DQ|t4ZopyIqIEBRAo0x6~o1zNV&ijRp70xYA0E zj0t&9E_kGBnkyi<2!rCe+{8u~f}z;UUEjiYxK#Z>7yTVK>ajDX*wNLBFUjdEK(5nL z&G4YZ7Y)Yv^Urj<-NY@sAjK-x;5B(O#aPZRqWGWs_>L=DKi$N4RjA&W_ZM7zf{OP6 zzHEdC)UQ!J#dTA<0EQbWh;BI*yBd5iNMBV`etOld_t{Y+R;|LTCM+BGWX@DIU%G7~ zpQJF8Zh*=a)FMa3Em2LJRy3qviI1ksuw$;3kes9y<8&j-VZyx84Fzh+RX^_D5z3$q zy$?3&j2Pjmn;}7hrqv*&zqpi0H?1xwm+6!BN%M*56>yv; zW=e1q&pW{u{zCk(@()(6OV70h>7svaHDyVS+CBqXfq>HBs7mLm51%nm`%eHPbZ!Wy z0^izpaq$q}hpBa%@a)urb!P#}a6-GoSa}H~7^6s!+IBn&E~(@L7xtevkfqj{dxjKc6aIFPgYD zHcVEQdxG+9wz>RaUc7FQaiUlw;TU%bdm)+|j=y zy?<20*hS=SlGWiWd_T0&MdYWT`ly|tFj|U$`L3D&dJ(*X34$*&iFhMgHNklMb9(!V zh8ZovZ3tY6Bxyn!2l@IEZhMUB8b9A4RMY42F&0^fmm~kiS-JFr()2>`8_+tkbfnF1 zsj>PE70mbR-O&227C?Wk3yQmJeCMiuA?EcWC*)rzvj36(yoWz;!P2xsDLe;XMT43+ xi_cH##uZVSN}D_7OD`1Y($GR_g_86EBvh$VD?|lau}BDbE0#0k#MXMogD>6W zp%Oe)>PmjA`CSMJ@q73@lbK{w5RoE{kB`r>&-uP{&abWCf8M@S{`{UPxX7minx?r* znF)R~Rf)@3Zo`}K;J5HH-1i+#&x~?9VZmR5M#6QD1^6C{LpTxB)Sl+J;4Po32xjKV<*j%m* z!9W`u+=zGlhGC_oi8*iac8m}9T2@%emUjI9S5+u`&*rf#LkZROAJ{Yo{$Dg+g)*1C z$3NvC@-=?vgx@}KBg*#?b$$p>*YLlA|4sbgdmbGBfIooxy-JzoFD#A-W>?OwC}c6QjZyN}>*ZP}fFmrV;qh9J2N=}K5iMl(_-^JU;q`Hu1L{HqF} z0EHtcxDor$H#W)UcjI#}`)=ZNgaw&{;Kc9Lk`g#4e$y~(k!3LDph5mvBmXQ1{MtWJ z>44RmJN&_k?@U-?Ncnb=1Zp~R=ZXuBtksy!d(mZ(zD(Dc-H`v1xZvE>1<%~{Yt_lD<$MiSWar9!Q=eEoOyV> zW`)w0NcMusaD2sYaVnc-%O9|*K&&ja&eTdR-%8oYP2jG3Ms=yGPa1QjSMC4;&psossu}+{WuIPy@f>$b9Q8D((Q}hv*jZkxqo#6_c zp{t+!>j|_@3CpOE1apICWuJcS59Un_V3p&lrk(pWmcIySG=8(HB_J=LDDqT*9F|nG zLfOF&a4A5`VweDI(%9EuqS{@MR=po$SQ|HscBBx-hFI~@ymqMZ8*#Ie-AA7|;!pTv z=Q~kqX9c1hyWZ2+{K>iFhw=LejqWkO=lt$+3d<|(CIUc+mx7;45}8`-RhM6uRC*X( zkn(J#WP^%Q_1cQC(e7NZ*r~mihYl~;N5$1PmiX(dw&pvR{1)m+qFk&J!EYx@N`xD4 zKqJ}saxQ;^D7*^agA*8rz%C3~1}LZ;Hsxelj2WYAW(LHnrHf9tm{>Y6M<<#V{O#R` z{`0Sq03GqwtFqs_(~L#cXn3b5Ob;Ed*N`Y3;G%JW!G!R)`JbufFDU)FJgL+pNj+=$ z*1Vxz_UjQ1AmTSC&%TRYrJ8b4=;}c+&INzKnBQ&!QbKrJu13z3 zvSK3SR;!(=r5U=Cx3w%PXh=6l4zX&~uK$mmHwznO!zAbB_yCw-*)R-`S*mufb~e|# zKg$GJ3`|IeEbg65eW~YvmpXAw>MD5`NCm6Q<~QRad-bL((OHk?B$)`}TZ2w=_+OU3_HfMmbNWT&-;1g$eNxh*jbd*3dp3h><~Y|N8|*H>U+N4htz??xOY2XZf2 zY8jAlgegKC%S4SN$U$o;^4^ikD3>*gs-{!iO)B9e3CLYh9O9jxcN6T10DEFssTGu z8=UnFPO^S>PDa+7nt8MqU17i}7oA6!|A{`@I*>G&;_v8w_87WBDy`kZTpe_)4*Cj5 z@AuG~O{A7HKz{-6W4I4oa2^#oxa9Ag+3ghh6zL29I65KNCHs+kLeJLSw$4W3^VUN9 zx2Ca0n1dbI#+z&;{DNIQ6ZgC zIys+NYw}t?4o?0I=?tC>nGEL1Q@FCM{Cb3v^YcoIGLuS6GV{{)GxJhXE2gwfN$lat z%uCKGO-W75%t1*%9T~D2IvH}_LO?@XC-3Dp zW^D!;KiOAEeDX8436m>%EE%_gtQG`Wy9s11RENamcRbNd8D}Q@@yg3)oXKDZ+Q8Yv zmYJ86nU^|c@)VfgfGQ^NN-<^Jn7p3Xi7n$A(3s1U8Chf|cL{RwPwwF?N=-}2&rQtC zo09Q(@-jiK$?<$rd>I#^wnzb$p93ma0C}Ai#5)DziJSnkjv`#+SDKV@a`JaRO?4JV z1_rQOF2Nj-1sA%G5Sr}EFUQC;Szb_%DdW-Pi@XY8mt}EIb`+4ubXk_zNU4wnHs9A*fzvt@vewE#OC#4-Unn-v_e!05N&J&Y6unM}NMHkJ%#1OQ^13G@H} diff --git a/docs/build/doctrees/installation/index.doctree b/docs/build/doctrees/installation/index.doctree new file mode 100644 index 0000000000000000000000000000000000000000..a5fa26a122f0a2a202d8186546bbb240af20f0fe GIT binary patch literal 6371 zcmds5TaO$^6<&L8_co-Jb5I zt9p0mAySYq%1VWJNGB36h<`zT0sH|Tc+MMd`~t*xs=9l6#%sq81_>O?Fbk24d2x{UnQ1evGuh8I zPD&@6m!YClEC&%&3POA@#%$!iR>C};H2N$!%J_iB4Y7fbb=&ys>paq?Ih)K$LZX|IaE(JfI%bV zr`=59pttrf=6%4^!pYe%W2tE3`P)Z{SI+db;9d%?*^uvg<0SV65-WHy=b@()FX?M0 zV~=@3l8(J(;KpakAq;p=wKJY3O6nv-Urf_83>>AvF6(-agj62>he^!6{@4qmB*sDP z5|fEtXUc8!yH}&tXCM6j73o#d2e#`u+Z~8o#1Qcn&_dh>|GtXfUHtChcONDfUl$#5 zQ|to&h05fxL)ZC;STw_TxtDQ31m^+1g6Rh4LB^Tpz8>-YWSy6s>!nTX)P;{ zU6Qf&wJLJJ^&eVi-ZsnSi5k1T-P~;&`5m)hw>0xghj35)?T`w5)+GBd#e?VB%`9Oa z{0ULyX@@Eh+NgH~KPbe{%raVfoFdH4({APx{_@i_l7ZC4ne9GdSzLT*=V_J=xrTOR zQ=nuy@}rU?%TVl1@MGItInRdAz?{Dj|7dL+a;EtA>Gub4O-rz+J#p81D0gm5`ceRx z@@ewoERQQMZV!?uN=|4cqBH}g5i9Hr>@t!ui#%pGjM=dqB7BqgCpG|t5`JI<$BE#e zE@rh)Sgff(jaa~&k!EkN3KD<%A3Z>W(#OxH^el6$VA5_Fvt`yI33yrL_oE~@YPwu> z#~Vsrno($-s=Zzh5|Q`2uu$&}vQ5VcIytT(x}LuK1#X`%)~HPK-`&(X1@QQddQK!Z zt{RRT~Z!Ac7#verRmkgFG)>NdZpU6L6c9KG{IHAVV^}lMH@V3aIQ%JHP@b{ zZDphF^H0;*?vKswrUUIPEB^rWKe1tJ{}rOq&}HiAFBa~$8XoebzHYyD#|uL5DbjYopVyXQUFX2LPT`b;>U#Le&g8;dk7^XC_5 zNfo=k+&I+4G8=ciRHpTz+=B(4@RYnp@~LVnDn zB&GZY&#DmbV)(Ybj%tA0llx9-&cX@MKmX6|(Xhj3FK>ri4M-+-*qXLOhkLat&g-hJ z@sF3W#%qnOC)W7;>+gzj&46=o|K97~4`)n4=>&{1$RkfWTOwM=2(fJ#N)E=>N&#%v z^&Ub@35c^Gi;;f_77w|y6d19iIx@S23W-mIPGpL0iRXDJ@fMHp+~I==4;5rX(2$a) zk~9$1X%k%uN$!%S@`;o2id<4VL@Bjh;iFVAB~>$czxMe!RPo6BJj5mxIb66fH}}FU zIlM@tuZw@$u>P0-7u+3Pcj#bEC|>MJxjSL)WWscY;4<}sRf*tquV?dk^fuB%ddbZ@ zU2K|&H2v9^ZC#%byL3%lFzZ2{Q6lUk(#MLj%isG7{*(lO%)>W55hB^YWw8AX? zltnoT7xmj={w1H%PNnV*jFP3l`PQMYG9IC9u*==c*dCXcj}>&xhDNv%o@GhqBfx|a&ww+j8X)i6 zKwOw!Wznuun42>_GfNykfJd5jx9&uTYW9ukj+x2kGMzyIC;^Bln<|hsAo}Gf^8j(w z&&);C=FAl;Mr5HMa?0YdjRZLk%n}Mu0~`~G$k500c_2>uSO zv3^7cDYaa#9761xRUAga1#Gbp!`I4TzK!oxyxXQPY=WGC3W~5Wtro)Mmr%s4o1o|> zc@>xw4?)C8j*#@cefgeQPkB0dh|^(E1WCbn=uXaIu2s1g#HyQ)aXrM{Bpdb$bCpI~ z1u)XrxDZg*v`Gq2J9oeFP2jnn4T72FNitdfYt`~_Rz{RX)vznM9@stL_C29T5jJaS z)`u5`S`_;$<|a5f@@x03GYQ}2NoVG=8poQQ`a%vxgdh03fSMiXzN$tHj`qtOeysr1 z729@AA6Y2F)k)Ca#2pKLV0h(TzBJxHFbKXc5+oJ-U8TEMx7al_e!BJ~DGgnb*WJf+n$tLnqwMP0!b=wckW?6Rz zS)+jqYiDMj$H!FpH7hQhz<)tS6jN=5!gm!Md%8_11!`&3vO$}W>b&nG;7v(gEf`{~ zHmDm^V4^ZILYp6I`mJ?Z= zg#5D_=TvS=+&GvCh932ksOEwl`lT6RJ-RiuVyoKKPTHDUAE7qW6x*-Pu2uHTnKq(F zkmM8_P&*5dvB21X6F1264@&t*fZ$2-4m<(nYxopO?FzPc8`eQ&N_?pnTk~C#aS-Jp U(Pc=yY=;!*%8)?UFA5_60*xeSoB#j- literal 0 HcmV?d00001 diff --git a/docs/build/doctrees/source/listwiz.doctree b/docs/build/doctrees/source/listwiz.doctree deleted file mode 100644 index a517778e9aa341705a6a2d385f60618149e233e8..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 7863 zcmeHLZEIY|6_zEhq+Lm?m((W2mb+2wT4}wz`A}M;wh%Bi1Y-r9#1Ke&nZ0**XIA&E zGjpX?OTeKGjp&dPa{H~NPy+d4NPkA5pZf<==r8CG=ri|i@2*$dUAfLD8-#bxyq)LF zInO!gKCb-n$&H2NpWc)qtY?fl><#*`7sPOcHkKJVKcN(tVH z6fhc0OWcu0{}tOMQbLH|6`y$NuT>`shl37O6SQmAM0!P$o|%f-CcDPg*>$$WcJ(jX z?@B6UyXT(zL`mKj(r%L`N9jyhi8L@od%CcHW#%8Uk$Ur#kYWH*dm*tcN}_9{&N z9sJ$I-!1&T2B7Q*3BYE$oZW^7mGTB%lfxTHzI{wuI;=LdR({wNI9GG<+?OF7s*z&L zp`AB9g!$%tFz=OMu8zRWuWDwRG&4^%4P9c>^Wcw758-#_ zgKw4KZ%u}uT{Q*%m@-r0OAB@>SiG6j zeCgQn4Di&kOC@c=g6ES~LH+Eu;jc@&Zb!l-39Cp6>$xON4SH2lWn2uIZ@WlkU6EMc ziS_a$;zpp@JxD^IPzL5p)O4%)(Kb4 z$`cxH%r;~h?oh8IL=jPzOOL4=-(S=fyTj2@yVQ zg%yGl50a`9U?&4A{zTWgA4bZez8yGN73*rGy3IRH$?^O8=%hu32!zFm@3>UJ&PG*R zA>9X&8a<_woD%EZv6-kXIqy$JOP%x=tb$SVNIsmdy-7=@gLWHY*$Ph;3;b3f zdhJ+WF)I@Vu+mc0LpD@+j#bE;H(&oD>{%CGd+c~486N+={CGqvG5(5bti`G7CU+p_ z+e~>bE~_fiK?pgD#rIeBE*#Rcir6dwSP~RQ<1@V_PkluO7UMnU;t$Sy*$s@}uS<_0 z%6=Iks3i>bQZi15mK)e4GwrU;2=u|jr@;m*Cnm)1qbS4`rnpWj=8Oc+;5~uO{VseU zXN4WZ6DY;T)^X1`uN#mw6ip?36vJn{4s{T}r%-`Ws&L5_8>@~i>Jjc*=mP{z>fulH zc2>#5S>0~RX=i$g`p2fC)~hL(Ab8=5+;=#FLs^Q59tAhSakilpTuY%lfZI5xe*O?_ zHzG}IY>07Mw-_v&5JGtl`HB&yzxUZ!>1gq&~opX(LH(4Y+7y&wxm4ioFK+vr4Y9SLE764IxdJ)5=L# zwy3|?s=Xslkw-?4AhKZ-KkzxCsC1!mfL7ie{NWs3zJC0tp*CMX{&PtmO#M%du%poF zsiUUqRn%$ypIus5n7LHz|HQ1m*1v=Qrj|XGETLc0mrWFah~7NB_m<%!)BoPDjn+l| zA0@{k2$J44>BeeNr~hM!^L{dG+50~&$@F*M^^g4E#4p+1TsQJS#Ut#Wvv}NcEx2RS z&;#guMzKVx8QRm_I*+gk<#ZJ}o5S;oYjwb}M`h=H)M_<`FMn{*80#);jYi|ZGu$ZT zK{AMZxI=S9Bw28RCXi79YCtACsOA3lypB%|1G{iQl+)_oDoTQbG%+DJg2AacrlyDQ z_l!xe^^K9(F3RFkQJ(kgd7G+pH(JWwsPglN58nb;%13MERcz^VTpF2_f^&+2pIj>ja(` zGd$z*1vC5&V5Tuc{{##A1A}}>2F4I`lR^I@?3%+-u1<86Q9pUX1T!(gKg@g0%LIQn zZ$2$&m?0Mpz| zU<~nWOfZ9^+?ePnFPI?ji%cgnWBahVcmXC@$EJ%j!QNyhD1SlToA|)rG!uOPBDT4e z*k+Uo9-PxHT#NzoCgJ~lY7zH$fMD*pH?W^A?q_g|n`k!lPVpHt|E7?9+gK~a$p@r0 b?%QtUm=9Jx^X;hSm@lo_M@f_VqE73-SbIq| diff --git a/docs/build/doctrees/source/modules.doctree b/docs/build/doctrees/source/modules.doctree deleted file mode 100644 index dbe722fd4e438013a11f53dec0f9c78d2d019b3e..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 2735 zcmZ8jTW=gS6i%D$HM^TjDMD%kLa4MA-7G>pAfAwTjK~9mN_{AnckEqT@z{gyX*Ng| z@KDr9eyjNh{7^p6%+Bs6(kkQQ<8%4WcaHs6=imQ^d(~e!a)pq3bxs-6hH)1|pP8)8 zx%TlxeExTQ8=r-NrPt1sHsdkuK_e4VG0Sy)9m6E4d#T)cbH3+z=B3f?anTW7(R&@A zi9zUi=@sAF3OyyAzm|W*qymkDU-&Ay-fX;!brju#!l#eoBn(I!q}UJLCbr9Pprq#U zvYgW}q~2ROFFkTfIqXa3QoOxPQRg7UcSqB_{_3-`*evEWyRv+dbjr~4beXoII1-P< zNIVw%;w=0&`_*ylW=nOWsdsW_T{fdrA$=xrkX#rnM=!p4KtX zkcXQ!-??F>;_lo!B>CyZ{c;XG`kBcKQ);#aT8*dJLu@AVmTv>v?0tru#pgiu3;dqo z_Y}Y9_&o}fU3Y*4s9IS8aoO&!%kod8VI*~?O2!uw;Q;XqHDN>FaqmG7^xsL_Pzwv9`gKQ&qsuT@ za?LIE#zrg{1<^gt3oH(6Hw3n?upBna(kiURK#U}Ur(L+~B)D&4I9(Xywefsw^Wt6@ zr*1~Q$ZBD19wC`Hkfk7?Wf~F=CLh%ju6QLO*U}5JZZmjn4m5pt8Ag^D#(JXo8?NHT z{V)_%waZR8;VTKOJoTkpD|JGL@p-v~yU8`R8dyQYa+*Uj@RnvgB^BR?iPS~u3D=on z(28MD`o;9SsgwAAyt_%bwZ;-bHB%rD3WwY>AH$I;{jQZxWhI8QJ3Dtwh(E)mHo6I5 zef06}#+{SlI3?hKk^nvm3B@p0R4+@qL_ zPkcJ&tHL-=wog_R$vk-@ovitJM3{7Ru2LdRl)ZH~h!@_x)@Ju{$qryfFIQ*ySvShe@*v0Gh<}9OdySM<4R(ldr!8o)f#s?wC)KjrlLv z=FzD%@fCN(x#WIP`9ROlgwGY64LqHrg;<)b{cr|C=A`Y-HUZ*_#E{!?>~6HDD->!`}rz@GnoGj{dHIXv;yE;(is?)Vb~1!{S` zQ9v8qVd*&#PIsjB%?~lGE!sslwGbW+koS_X{uZyqOBV)7;BN{5`! + +.. _ContributingDocs: + +3. Contributing to the documentation +------------------------------------- + +In the issues section of the project, you can find issues that are labeled +:code:`documentation`. These are issues that are related to the documentation of +the project. You can choose one of these issues to work on. + +The documentation is a crucial part of any open-source project. It helps users +understand how to use the software and how to contribute to it. + +All the files for the documentation are in the :code:`docs` directory. The +documentation is written in `reStructuredText +`_. The +documentation is built using `Sphinx `_. + +In order to modify the documentation, you need to change the files in the +:code:`docs` directory. Open the project in your preferred editor. If you do not +have a preferred editor `Visual Studio Code `_ is +recommended. + +Take a few minutes to familiarize yourself with the structure of the +documentation. The main file for the documentation is :code:`index.rst` which is +in the :code:`docs` directory. This file includes all the other files in the +documentation. The documentation is split into different sections, each of which +is in a separate folder in the :code:`docs` directory. + + +Checking the modification +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +To build the documentation, the first thing you need to do is to download +`Sphinx `_. You can do this via `pip`:: + + $ python -m pip install sphinx + +To build the documentation navigate to the :code:`docs` directory:: + + $ cd docs + +and run the command:: + + $ make html + Running Sphinx v5.0.2 + loading pickled environment... done + building [mo]: targets for 0 po files that are out of date + building [html]: targets for 0 source files that are out of date + updating environment: 0 added, 0 changed, 0 removed + looking for now-outdated files... none found + no targets are out of date. + build succeeded. + + The HTML pages are in build/html. + +You can open :code:`_build/html/index.html` in a browser to see the +documentation locally which should include the changes you made. + + +Committing the change +^^^^^^^^^^^^^^^^^^^^^ + +Once you are done with your changes, you need to commit them. First, you need to +**stage** the files you have changed. To do this, run the following command:: + + $ git add + +Do this for all the files you have changed. Once you have staged all the files, +you can commit them:: + + $ git commit + +This will open a text editor where you can write your commit title and message. + + +Checklist +^^^^^^^^^ + +| |uncheck| Choose an issue labeled :code:`documentation` from the issues section. +| |uncheck| Familiarize yourself with the structure of the documentation. +| |uncheck| Make the necessary changes to the documentation. +| |uncheck| Build the documentation using `Sphinx `_. +| |uncheck| Check the changes you made by opening :code:`_build/html/index.html` in a browser. +| |uncheck| Add the changes to the staging area. +| |uncheck| Commit the changes. \ No newline at end of file diff --git a/docs/build/html/_sources/contributing/contributing_function.rst.txt b/docs/build/html/_sources/contributing/contributing_function.rst.txt new file mode 100644 index 0000000..f426889 --- /dev/null +++ b/docs/build/html/_sources/contributing/contributing_function.rst.txt @@ -0,0 +1,84 @@ +.. |uncheck| raw:: html + + + +.. _ContributingFunction: + +5. Contributing a new function +------------------------------- + +Navigate to the issues tab of the repository and find an issue that you would +like to work on. Some of these issues are tagged as :code:`enhancement`. The +issue will have a description of the function that needs to be implemented, and +where the function code should be included. + +In your function you need to remember to include a docstring that describes what +the function does. This is important for users of the software to understand how +to use the function. The docstring should be in the following format:: + + def function_name(arguments): + """ + Description of the function. + + Parameters + ---------- + arguments : type + Description of the argument. + + Returns + ------- + type + Description of the return value. + """ + + # code for the function + + +Documenting your function +^^^^^^^^^^^^^^^^^^^^^^^^^^ + + +Testing your function +^^^^^^^^^^^^^^^^^^^^^ + +Before you commit your changes, you need to test your function. To do this, you +need to run the test suite. The test suite is in the :code:`tests` directory. +The test suite is written using `pytest `_. +To run the test suite, run the command from the root of the project folder:: + + $ pytest tests + ============================= test session starts ============================== + platform linux -- Python 3.8.5, pytest-6.2.2, pluggy-0.13.1 + rootdir: /home/nikoleta/Documents/a-hitchhikers-guide-to-contributing-to-open-source + collected 0 items + + ============================== no tests ran in 0.01s ============================== + + +Committing the change +^^^^^^^^^^^^^^^^^^^^^ + +Once you are done with your changes, you need to commit them. First, you need to +**stage** the files you have changed. To do this, run the following command:: + + $ git add + +Do this for all the files you have changed. Once you have staged all the files, +you can commit them:: + + $ git commit + +This will open a text editor where you can write your commit title and message. + + +Checklist +^^^^^^^^^ + +| |uncheck| Choose an issue labeled :code:`enhancement` from the issues section. +| |uncheck| Familiarize yourself with the structure of the source code. +| |uncheck| Implement the new function. +| |uncheck| Include a docstring in the function. +| |uncheck| Implement a test for your new function. +| |uncheck| Test the function using the test suite. +| |uncheck| Add the changes to the staging area. +| |uncheck| Commit the changes. \ No newline at end of file diff --git a/docs/build/html/_sources/contributing/contributing_test.rst.txt b/docs/build/html/_sources/contributing/contributing_test.rst.txt new file mode 100644 index 0000000..b89a524 --- /dev/null +++ b/docs/build/html/_sources/contributing/contributing_test.rst.txt @@ -0,0 +1,58 @@ +.. |uncheck| raw:: html + + + +.. _ContributingTest: + +4. Contributing a test +---------------------- + +Navigate to the issues tab of the repository and find an issue that you would +like to work on. Some of these issues are tagged as :code:`enhancement`. The +issue will have a description of the function that needs to be implemented, and +where the function code should be included. + +Testing your function +^^^^^^^^^^^^^^^^^^^^^ + +Before you commit your changes, you need to test your function. To do this, you +need to run the test suite. The test suite is in the :code:`tests` directory. +The test suite is written using `pytest `_. +To run the test suite, run the command from the root of the project folder:: + + $ pytest tests + ============================= test session starts ============================== + platform linux -- Python 3.8.5, pytest-6.2.2, pluggy-0.13.1 + rootdir: /home/nikoleta/Documents/a-hitchhikers-guide-to-contributing-to-open-source + collected 0 items + + ============================== no tests ran in 0.01s ============================== + + +Committing the change +^^^^^^^^^^^^^^^^^^^^^ + +Once you are done with your changes, you need to commit them. First, you need to +**stage** the files you have changed. To do this, run the following command:: + + $ git add + +Do this for all the files you have changed. Once you have staged all the files, +you can commit them:: + + $ git commit + +This will open a text editor where you can write your commit title and message. + + +Checklist +^^^^^^^^^ + +| |uncheck| Choose an issue labeled :code:`enhancement` from the issues section. +| |uncheck| Familiarize yourself with the structure of the source code. +| |uncheck| Implement the new function. +| |uncheck| Include a docstring in the function. +| |uncheck| Implement a test for your new function. +| |uncheck| Test the function using the test suite. +| |uncheck| Add the changes to the staging area. +| |uncheck| Commit the changes. \ No newline at end of file diff --git a/docs/build/html/_sources/contributing/forking.rst.txt b/docs/build/html/_sources/contributing/forking.rst.txt new file mode 100644 index 0000000..9fd1b25 --- /dev/null +++ b/docs/build/html/_sources/contributing/forking.rst.txt @@ -0,0 +1,47 @@ +.. _Forking: + +1. Forking and Cloning the repository +------------------------------------- + +Forking the repository +^^^^^^^^^^^^^^^^^^^^^^ + +Most projects have protected GitHub repositories, meaning you cannot make +changes directly to the source code. Instead, you need to create a copy of the +source code under your own GitHub account and then make changes to that copy. +This process is called a **fork**. To do this, navigate to the GitHub repository +of the project +(https://github.com/Nikoleta-v3/a-hitchhikers-guide-to-contributing-to-open-source) +and click the :code:`Fork` button. Then choose your GitHub account as the +**onwer** and click on :code:`Create fork`. + + +.. image:: /_static/forking.png + + +Cloning the repository +^^^^^^^^^^^^^^^^^^^^^^ + +Once we have a fork of the repository on **your** Github account, create a copy +of it to your computer. This is called cloning. Do this by clicking the +:code:`Code` button and copying the address of the repository to your clipboard: + +.. image:: /_static/cloning.png + +Note that we want to copy the address of the repository using the `SSH` +protocol. Now, open your command line tool and type `git clone`, then paste the +address you just copied. The command should look like the following, where +`` is replaced with your GitHub username:: + + + $ git clone httpsgit@github.com:/a-hitchhikers-guide-to-contributing-to-open-source.git + +This will download the source code to your computer:: + + Cloning into 'a-hitchhikers-guide-to-contributing-to-open-source'... + remote: Enumerating objects: 117, done. + remote: Counting objects: 100% (117/117), done. + remote: Compressing objects: 100% (94/94), done. + remote: Total 117 (delta 14), reused 105 (delta 9), pack-reused 0 (from 0) + Receiving objects: 100% (117/117), 3.63 MiB | 3.43 MiB/s, done. + Resolving deltas: 100% (14/14), done. \ No newline at end of file diff --git a/docs/build/html/_sources/contributing/index.rst.txt b/docs/build/html/_sources/contributing/index.rst.txt index 5fcb7cd..d13494b 100644 --- a/docs/build/html/_sources/contributing/index.rst.txt +++ b/docs/build/html/_sources/contributing/index.rst.txt @@ -1,254 +1,51 @@ -Make a contribution to the documentation -============================================ +Make a Contribution to `listwiz` +================================ -In this tutorial we will learn how to make a contribution to `listwiz`. +In this tutorial, we will learn how to contribute to `listwiz`. -Open source projects are typically hosted on platforms like GitHub, GitLab, or +Open-source projects are typically hosted on platforms like GitHub, GitLab, or others, with the source code managed using Git. In this tutorial, we will use GitHub as an example. To make a contribution, you need to have a GitHub account. You can create an account by navigating to GitHub: http://github.com. If you are in education, you can apply for a specific education account here: https://education.github.com. +Now that you have your account, there are a few more initial steps that you will +need to take before you can start contributing to the project. The first step is +to create a fork of the project and bring a copy of the project to your +computer: -Forking the repository ----------------------- +- :ref:`Forking` -Most projects have protected GitHub repositories, meaning you cannot make -changes directly to the source code. Instead, you need to create a copy of the -source code under your own GitHub account and then make changes to that copy. -This process is called a **fork**. To do this, navigate to the GitHub repository -of the project -(https://github.com/Nikoleta-v3/a-hitchhikers-guide-to-contributing-to-open-source) -and click the :code:`Fork` button. Then choose your GitHub account as the -**onwer** and click on :code:`Create fork`. +Now you are ready to start contributing. There are several tasks that you can +do, such as including documentation, writing tests, or implementing functions. +You can nagivate to the issues tab of the repository and find an issue that you +would like to work on. Once you choose what you want to work on, remember to +create a branch before you start implementing. +- :ref:`Branching` +- :ref:`ContributingDocs` +- :ref:`ContributingTest` +- :ref:`ContributingFunction` -.. image:: /_static/forking.png +In each section, you will find information on how to implement each step, as +well as a checklist of things you need to complete. These include compiling the +documentation, running the test suite, and committing your changes! -Cloning the repository ----------------------- +Now you are ready to ask for your new developed code to be part of the source +code of the project! For that you need to follow the instructions: -Once we have a fork of the repository on **your** Github account, create a copy -of it to your computer. This is called cloning. Do this by clicking the -:code:`Code` button and copying the address of the repository to your clipboard: +- :ref:`PushingAndPullRequest` -.. image:: /_static/cloning.png +Thus as a summary the steps you have to take can be summarised as follows: -Note that we want to copy the address of the repository using the `SSH` -protocol. Now, open your command line tool and type `git clone`, then paste the -address you just copied. The command should look like the following, where -`` is replaced with your GitHub username:: +.. toctree:: + :maxdepth: 2 + forking.rst + branching.rst + contributing_docs.rst + contributing_test.rst + contributing_function.rst + pull_request.rst - $ git clone httpsgit@github.com:/a-hitchhikers-guide-to-contributing-to-open-source.git - -This will download the source code to your computer:: - - Cloning into 'a-hitchhikers-guide-to-contributing-to-open-source'... - remote: Enumerating objects: 117, done. - remote: Counting objects: 100% (117/117), done. - remote: Compressing objects: 100% (94/94), done. - remote: Total 117 (delta 14), reused 105 (delta 9), pack-reused 0 (from 0) - Receiving objects: 100% (117/117), 3.63 MiB | 3.43 MiB/s, done. - Resolving deltas: 100% (14/14), done. - -Creating a branch ------------------ - -Before we start making changes to the source code, the first thing we will do is -create a new branch. This is because we want to keep the changes we are about to -make separate from the main source code. To do this, first change directory into -the source code:: - - $ cd a-hitchhikers-guide-to-contributing-to-open-source - -Now, to create a new branch, type the following:: - - $ git branch the-name-of-the-branch - -Note that the name of the branch should be descriptive of the changes you are -going to make. For example, if you are going to add a new function to the source -code, you could name the branch :code:`implementing-new-function`. - -Now checkout to that branch:: - - $ git checkout the-name-of-the-branch - - -Modifying the documentation ---------------------------- - -One set of changes you can make to the source code is to the documentation. The -documentation is a crucial part of any open-source project. It helps users -understand how to use the software and how to contribute to it. - -All the files for the documentation are in the :code:`docs` directory. The -documentation is written in `reStructuredText -`_. The -documentation is built using `Sphinx `_. - -In order to modify the documentation, you need to change the files in the -:code:`docs` directory. Open the project in your preferred editor. If you do not -have a preferred editor `Visual Studio Code `_ is -recommended. - -Take a few minutes to familiarize yourself with the structure of the -documentation. The main file for the documentation is :code:`index.rst` which is -in the :code:`docs` directory. This file includes all the other files in the -documentation. The documentation is split into different sections, each of which -is in a separate folder in the :code:`docs` directory. - - -Checking the modification -^^^^^^^^^^^^^^^^^^^^^^^^^^ - -To build the documentation, the first thing you need to do is to download -`Sphinx `_. You can do this via `pip`:: - - $ python -m pip install sphinx - -To build the documentation navigate to the :code:`docs` directory:: - - $ cd docs - -and run the command:: - - $ make html - Running Sphinx v5.0.2 - loading pickled environment... done - building [mo]: targets for 0 po files that are out of date - building [html]: targets for 0 source files that are out of date - updating environment: 0 added, 0 changed, 0 removed - looking for now-outdated files... none found - no targets are out of date. - build succeeded. - - The HTML pages are in build/html. - -You can open :code:`_build/html/index.html` in a browser to see the -documentation locally which should include the changes you made. - - -Implementing a function ------------------------- - -Navigate to the issues tab of the repository and find an issue that you would -like to work on. Some of these issues are tagged as :code:`enhancement`. The issue -will have a description of the function that needs to be implemented, and where -the function code should be included. - -In your function you need to remember to include a docstring that describes what -the function does. This is important for users of the software to understand how -to use the function. The docstring should be in the following format:: - - def function_name(arguments): - """ - Description of the function. - - Parameters - ---------- - arguments : type - Description of the argument. - - Returns - ------- - type - Description of the return value. - """ - - # code for the function - - -Documenting your function -^^^^^^^^^^^^^^^^^^^^^^^^^^ - - -Testing your function -^^^^^^^^^^^^^^^^^^^^^ - -Before you commit your changes, you need to test your function. To do this, you -need to run the test suite. The test suite is in the :code:`tests` directory. -The test suite is written using `pytest `_. -To run the test suite, run the command from the root of the project folder:: - - $ pytest tests - ============================= test session starts ============================== - platform linux -- Python 3.8.5, pytest-6.2.2, pluggy-0.13.1 - rootdir: /home/nikoleta/Documents/a-hitchhikers-guide-to-contributing-to-open-source - collected 0 items - - ============================== no tests ran in 0.01s ============================== - - -Committing the change ---------------------- - -Once you are done with your changes, you need to commit them. First, you need to -**stage** the files you have changed. To do this, run the following command:: - - $ git add - -Do this for all the files you have changed. Once you have staged all the files, -you can commit them:: - - $ git commit - -This will open a text editor where you can write your commit title and message. - - -Pushing the change to Github ----------------------------- - -Now that all that is done, you are going to send the changes back to your copy -of the source code on Github:: - - $ git push origin the-name-of-the-branch - - -Opening a Pull Request ----------------------- - -You now have 2 copies of the modified source code of the `listwiz` project. One -locally on your computer, the other under your Github account. So first you will -push your locally modified source code to your Github account. To do this run -the command:: - - $ git push origin the-name-of-the-branch - -Now we want to merge the changes from your Github account to the main source -code of `listwiz`. To do this, open a Pull Request. To do this, navigate to the -repository on your Github account. You should see a :code:`Compare and Pull -Request` button: - -.. image:: /_static/compare_button.png - -Making further modifications ----------------------------- - -Once a Pull Request is opened, a number of automated checks will start. This -will check the various software tests but also build a viewable version of the -documentation. - -You can click on the corresponding :code:`details` button to see any of these. - - -No that your modification will also be reviewed. To make any required changes, -**modify the files** in your computer as you did before. - -Then stage and commit the files:: - - $ git add - $ git commit - -This will open a text editor where you can write your commit title and message -(similarly to before). - -Once this is done, push the code to Github which will automatically update the -pull request:: - - $ git push origin add-name-to-contributors-list - -This final process of making further modifications might repeat itself and -eventually the Pull Request will be **merged** and your changes included in the -main version of the source code. \ No newline at end of file diff --git a/docs/build/html/_sources/contributing/installation.rst.txt b/docs/build/html/_sources/contributing/installation.rst.txt new file mode 100644 index 0000000..e69de29 diff --git a/docs/build/html/_sources/contributing/pull_request.rst.txt b/docs/build/html/_sources/contributing/pull_request.rst.txt new file mode 100644 index 0000000..4abddd0 --- /dev/null +++ b/docs/build/html/_sources/contributing/pull_request.rst.txt @@ -0,0 +1,60 @@ +.. _PushingAndPullRequest: + +6. Pushing to Github and Opening a Pull Request +=============================================== + +Pushing the change to Github +---------------------------- + +Now that all that is done, you are going to send the changes back to your copy +of the source code on Github:: + + $ git push origin the-name-of-the-branch + + +Opening a Pull Request +---------------------- + +You now have 2 copies of the modified source code of the `listwiz` project. One +locally on your computer, the other under your Github account. So first you will +push your locally modified source code to your Github account. To do this run +the command:: + + $ git push origin the-name-of-the-branch + +Now we want to merge the changes from your Github account to the main source +code of `listwiz`. To do this, open a Pull Request. To do this, navigate to the +repository on your Github account. You should see a :code:`Compare and Pull +Request` button: + +.. image:: /_static/compare_button.png + +Making further modifications +---------------------------- + +Once a Pull Request is opened, a number of automated checks will start. This +will check the various software tests but also build a viewable version of the +documentation. + +You can click on the corresponding :code:`details` button to see any of these. + + +No that your modification will also be reviewed. To make any required changes, +**modify the files** in your computer as you did before. + +Then stage and commit the files:: + + $ git add + $ git commit + +This will open a text editor where you can write your commit title and message +(similarly to before). + +Once this is done, push the code to Github which will automatically update the +pull request:: + + $ git push origin add-name-to-contributors-list + +This final process of making further modifications might repeat itself and +eventually the Pull Request will be **merged** and your changes included in the +main version of the source code. \ No newline at end of file diff --git a/docs/build/html/_sources/how-to/examplefuction.rst.txt b/docs/build/html/_sources/how-to/examplefuction.rst.txt deleted file mode 100644 index 22ce039..0000000 --- a/docs/build/html/_sources/how-to/examplefuction.rst.txt +++ /dev/null @@ -1,4 +0,0 @@ -.. _examplefunction: - -Example Function -=================== diff --git a/docs/build/html/_sources/how-to/index.rst.txt b/docs/build/html/_sources/how-to/index.rst.txt deleted file mode 100644 index 1d724ad..0000000 --- a/docs/build/html/_sources/how-to/index.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -How To -======= - -.. toctree:: - :maxdepth: 1 - - examplefuction.rst \ No newline at end of file diff --git a/docs/build/html/_sources/index.rst.txt b/docs/build/html/_sources/index.rst.txt index e6cd801..73bee38 100644 --- a/docs/build/html/_sources/index.rst.txt +++ b/docs/build/html/_sources/index.rst.txt @@ -11,13 +11,18 @@ streaks, and identify the most frequently occurring elements:: >>> sorted_list [1, 2, 3, 4, 5, 6, 7, 8, 9, 10] +Table of Contents +================= -The purpose of this package is to help you learn how to contribute to open -source projects. For more information, check out the tutorial: +.. To install the package your computer see the installation guideliens. + +.. The purpose of this package is to help you learn how to contribute to open +.. source projects. For more information, check out the tutorial: .. toctree:: - :maxdepth: 1 + :maxdepth: 2 + installation/index.rst contributing/index.rst Indices and tables diff --git a/docs/build/html/_sources/installation/index.rst.txt b/docs/build/html/_sources/installation/index.rst.txt new file mode 100644 index 0000000..c991b97 --- /dev/null +++ b/docs/build/html/_sources/installation/index.rst.txt @@ -0,0 +1,39 @@ +Installation Guide +================== + +To install the package, you first need to obtain a copy of the project's +repository on your computer. This is done by cloning the repository. + +We recommend that you first create a fork of the repository (refer to +:ref:`Forking` for more details). + +After forking the repository, clone your fork to your computer by running the +following command in your terminal after navigating to the directory where you +want to place the project:: + + + $ git clone https://github.com//a-hitchhikers-guide-to-contributing-to-open-source.git + + +Replace `` with your actual GitHub username. Next, +navigate to the project directory:: + + + $ cd a-hitchhikers-guide-to-contributing-to-open-source + + +Then, install the package by running the following command:: + + $ pip install . + + +If you want to install the package in development mode, use the following +command instead:: + + + $ pip install -e . + + +*Why install in development mode?* Development mode is useful if you plan to +modify the code. In this mode, any changes you make to the source files are +immediately reflected in the installed package, without needing to reinstall it. \ No newline at end of file diff --git a/docs/build/html/_sources/source/listwiz.rst.txt b/docs/build/html/_sources/source/listwiz.rst.txt deleted file mode 100644 index 221f2fc..0000000 --- a/docs/build/html/_sources/source/listwiz.rst.txt +++ /dev/null @@ -1,37 +0,0 @@ -listwiz package -=============== - -Submodules ----------- - -listwiz.inspect module ----------------------- - -.. automodule:: listwiz.inspect - :members: - :undoc-members: - :show-inheritance: - -listwiz.replace module ----------------------- - -.. automodule:: listwiz.replace - :members: - :undoc-members: - :show-inheritance: - -listwiz.sorting module ----------------------- - -.. automodule:: listwiz.sorting - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: listwiz - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/build/html/_sources/source/modules.rst.txt b/docs/build/html/_sources/source/modules.rst.txt deleted file mode 100644 index 8d91e09..0000000 --- a/docs/build/html/_sources/source/modules.rst.txt +++ /dev/null @@ -1,7 +0,0 @@ -listwiz -======= - -.. toctree:: - :maxdepth: 4 - - listwiz diff --git a/docs/build/html/how-to/examplefuction.html b/docs/build/html/contributing/branching.html similarity index 52% rename from docs/build/html/how-to/examplefuction.html rename to docs/build/html/contributing/branching.html index 1500a28..2ac8916 100644 --- a/docs/build/html/how-to/examplefuction.html +++ b/docs/build/html/contributing/branching.html @@ -4,7 +4,7 @@ - Example Function — listwiz 0.0.1 documentation + 2. Creating a branch — listwiz 0.0.1 documentation @@ -21,7 +21,8 @@ - + + @@ -44,9 +45,14 @@ @@ -60,9 +61,9 @@
@@ -70,22 +71,7 @@
diff --git a/docs/build/html/contributing/pull_request.html b/docs/build/html/contributing/pull_request.html new file mode 100644 index 0000000..249fe7d --- /dev/null +++ b/docs/build/html/contributing/pull_request.html @@ -0,0 +1,170 @@ + + + + + + + 6. Pushing to Github and Opening a Pull Request — listwiz 0.0.1 documentation + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+
+ +
+
+
+
+ +
+

6. Pushing to Github and Opening a Pull Request

+
+

Pushing the change to Github

+

Now that all that is done, you are going to send the changes back to your copy +of the source code on Github:

+
$ git push origin the-name-of-the-branch
+
+
+
+
+

Opening a Pull Request

+

You now have 2 copies of the modified source code of the listwiz project. One +locally on your computer, the other under your Github account. So first you will +push your locally modified source code to your Github account. To do this run +the command:

+
$ git push origin the-name-of-the-branch
+
+
+

Now we want to merge the changes from your Github account to the main source +code of listwiz. To do this, open a Pull Request. To do this, navigate to the +repository on your Github account. You should see a Compare and Pull +Request button:

+../_images/compare_button.png +
+
+

Making further modifications

+

Once a Pull Request is opened, a number of automated checks will start. This +will check the various software tests but also build a viewable version of the +documentation.

+

You can click on the corresponding details button to see any of these.

+

No that your modification will also be reviewed. To make any required changes, +modify the files in your computer as you did before.

+

Then stage and commit the files:

+
$ git add <name of the file tou want to commit>
+$ git commit
+
+
+

This will open a text editor where you can write your commit title and message +(similarly to before).

+

Once this is done, push the code to Github which will automatically update the +pull request:

+
$ git push origin add-name-to-contributors-list
+
+
+

This final process of making further modifications might repeat itself and +eventually the Pull Request will be merged and your changes included in the +main version of the source code.

+
+
+ + +
+
+ +
+
+
+
+ + + + \ No newline at end of file diff --git a/docs/build/html/genindex.html b/docs/build/html/genindex.html index 762bc9e..6892a9e 100644 --- a/docs/build/html/genindex.html +++ b/docs/build/html/genindex.html @@ -42,7 +42,8 @@
diff --git a/docs/build/html/index.html b/docs/build/html/index.html index d0cd78b..8051ab3 100644 --- a/docs/build/html/index.html +++ b/docs/build/html/index.html @@ -21,7 +21,7 @@ - + @@ -44,7 +44,8 @@ @@ -83,11 +84,21 @@

Welcome to listwiz’s documentation![1, 2, 3, 4, 5, 6, 7, 8, 9, 10] -

The purpose of this package is to help you learn how to contribute to open -source projects. For more information, check out the tutorial:

+ +
+

Table of Contents

@@ -104,7 +115,7 @@

Indices and tables - +
diff --git a/docs/build/html/how-to/index.html b/docs/build/html/installation/index.html similarity index 55% rename from docs/build/html/how-to/index.html rename to docs/build/html/installation/index.html index da4d5e7..9b13b5a 100644 --- a/docs/build/html/how-to/index.html +++ b/docs/build/html/installation/index.html @@ -4,7 +4,7 @@ - How To — listwiz 0.0.1 documentation + Installation Guide — listwiz 0.0.1 documentation @@ -21,8 +21,8 @@ - - + + @@ -45,11 +45,8 @@ @@ -66,9 +63,9 @@
@@ -76,21 +73,43 @@
-
-

How To

-
- +
+

Installation Guide

+

To install the package, you first need to obtain a copy of the project’s +repository on your computer. This is done by cloning the repository.

+

We recommend that you first create a fork of the repository (refer to +1. Forking and Cloning the repository for more details).

+

After forking the repository, clone your fork to your computer by running the +following command in your terminal after navigating to the directory where you +want to place the project:

+
$ git clone https://github.com/<your-github-username>/a-hitchhikers-guide-to-contributing-to-open-source.git
+
+
+

Replace <your-github-username> with your actual GitHub username. Next, +navigate to the project directory:

+
$ cd a-hitchhikers-guide-to-contributing-to-open-source
+
+
+

Then, install the package by running the following command:

+
$ pip install .
+
+
+

If you want to install the package in development mode, use the following +command instead:

+
$ pip install -e .
+
+

Why install in development mode? Development mode is useful if you plan to +modify the code. In this mode, any changes you make to the source files are +immediately reflected in the installed package, without needing to reinstall it.

diff --git a/docs/build/html/objects.inv b/docs/build/html/objects.inv index 1a346297eecb0cb5c3028acff8cab5ce5864acd0..fcc31b9302522137949824ccf9be80e31f9f7033 100644 GIT binary patch delta 847 zcmV-V1F-y_0=EZ{b$_jwPj8zr6u|HP6rPH-lT&4Dcc`XaGPUZVTC`Q#v30-+Rte6) zsLM|K8vAwnl=_1XjP7BDUd=1L51 z3Y^F3fD>AvcEhS7jEt(_t=c^Be&JCdXUdI)#nqnVTu8Hgz^ME1B$P^H+&M;^sr&m# zVRv=PF1Ttrhao2=AM1{k?QsVq1-WWDpxNNMV=^bNa9ic^lrLfBd(8_Vs)5%XH(Yz* z!vY?vGBsalM}K)*ZB)*%1Ie}gp~^CmHb1K2Pb0;ijF@)IfMt9%Sf#813qPd>vS8uJ zx^d*LapX(w$XYt`Rm+1q8^>pC)SsboO5zt=9($J1Esf`nVXg5@;MT+wUpo_D!7Pd`IR~jm0Rt2D9pegMa?GDx2c-pNM=Q?t=jhqWeQX zuHT$4=y7Jf@;_DL!=V^wuntx(RgLL&)vmfva5gs-Uiw`UU zBMau0{%S)@j^M8;E=>MWA}5&5O9lQL}!jh7Kp{3w^O$I|7|Z6>|`q160GU= zR44Mi{0Tah>PUPinV0~?DagOS|CD~(y^#bOlTuxs<4s0dDc%4tjHuc&jOcww8+diT zt7t;nz~=p>M{mxN*1LC6ck&2ywf)=ovim@L-G92`R_l5;pXzxavX0Y|A~r3TBG)kk zIn^J9wv7I^DntSl-r7=5+5|NS84&V84+BV*6923)xoPLG*@j4^WbbZBZ@xXmwZS1jtD+djK>;#$Z~F|FI7aUOT<+ ZZM)M2uVi$cx&k0*Jx^i@ zZERB$cjQ0*f1oIEW2=^JsCPDKyhCJt(4?T)gIdw8VejB1uLyF6DF73&K^U5?$G|d$ zqQ>wYb+SU2W~Vfd9n(>)+_M`Obc#GCg|m@6`*=TJajDt}Pb&I{>(&<&7~f91bvRmQ f^iQqq*$ls2v?Iz!nPo9&xpU6Elr@SEBKCt}K<81l diff --git a/docs/build/html/search.html b/docs/build/html/search.html index 66b1a74..666915e 100644 --- a/docs/build/html/search.html +++ b/docs/build/html/search.html @@ -45,7 +45,8 @@
diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js index 1e32c4f..e2cc57f 100644 --- a/docs/build/html/searchindex.js +++ b/docs/build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["contributing/index", "index"], "filenames": ["contributing/index.rst", "index.rst"], "titles": ["Make a contribution to the documentation", "Welcome to listwiz\u2019s documentation!"], "terms": {"thi": [0, 1], "tool": 0, "allow": 1, "you": [0, 1], "handl": 1, "list": [0, 1], "sort": 1, "them": [0, 1], "find": [0, 1], "longest": 1, "increas": 1, "streak": 1, "identifi": 1, "most": [0, 1], "frequent": 1, "occur": 1, "element": 1, "index": [0, 1], "modul": 1, "search": 1, "page": [0, 1], "In": [0, 1], "inform": 1, "about": [0, 1], "project": [0, 1], "import": [0, 1], "exampl": 0, "implement": [], "function": [], "The": [0, 1], "purpos": 1, "packag": 1, "help": [0, 1], "learn": [0, 1], "how": [0, 1], "contribut": 1, "open": 1, "sourc": [0, 1], "ha": [], "two": [], "main": 0, "part": 0, "These": [], "ar": 0, "guidelin": [], "set": 0, "make": 1, "tutori": [0, 1], "we": 0, "listwiz": 0, "navig": 0, "http": 0, "com": 0, "an": 0, "account": 0, "If": 0, "educ": 0, "can": 0, "appli": 0, "specif": 0, "here": 0, "nikoleta": 0, "v3": 0, "hitchhik": 0, "guid": 0, "hub": [], "develop": [], "code": 0, "cannot": 0, "copi": 0, "so": 0, "need": 0, "your": [], "own": 0, "under": 0, "do": 0, "click": 0, "button": 0, "follow": 0, "instruct": [], "onc": 0, "have": 0, "comput": 0, "call": 0, "address": 0, "clipboard": 0, "now": 0, "command": 0, "line": 0, "type": 0, "replac": 0, "usernam": 0, "git": 0, "download": 0, "remot": 0, "enumer": 0, "object": 0, "1813": [], "done": 0, "count": 0, "100": 0, "362": [], "compress": 0, "225": [], "total": 0, "delta": 0, "160": [], "reus": 0, "233": [], "79": [], "pack": 0, "1451": [], "receiv": 0, "439": [], "94": 0, "kib": [], "2": [0, 1], "67": [], "mib": 0, "s": 0, "resolv": 0, "905": [], "order": 0, "must": [], "new": 0, "after": [], "first": 0, "directori": 0, "nashpi": [], "cd": 0, "keep": 0, "separ": 0, "from": 0, "task": [], "checkout": 0, "issu": 0, "entir": [], "which": 0, "caus": [], "ani": 0, "problem": [], "python": 0, "m": 0, "pip": 0, "instal": 0, "tox": [], "stage": 0, "file": 0, "add": 0, "doc": 0, "refer": [], "contributor": 0, "rst": 0, "text": 0, "editor": 0, "where": 0, "write": 0, "titl": 0, "messag": 0, "i": [], "am": [], "close": [], "made": 0, "all": 0, "go": 0, "send": 0, "back": 0, "origin": 0, "name": 0, "One": 0, "local": 0, "other": 0, "includ": 0, "those": [], "To": 0, "should": 0, "see": 0, "compar": 0, "review": 0, "eventu": 0, "number": 0, "autom": 0, "start": 0, "variou": 0, "softwar": 0, "also": 0, "build": 0, "viewabl": 0, "version": 0, "correspond": 0, "detail": 0, "requir": 0, "Then": 0, "similarli": 0, "befor": 0, "automat": 0, "updat": 0, "final": 0, "process": 0, "might": 0, "repeat": 0, "itself": 0, "merg": 0, "fork": [], "repositori": [], "clone": [], "repository\u00e5": [], "creat": [], "branch": [], "modifi": [], "check": 1, "modif": [], "run": 0, "test": [], "suit": 0, "commit": [], "chang": [], "push": [], "github": [], "pull": [], "request": [], "further": [], "host": 0, "gitlab": 0, "manag": 0, "us": 0, "protect": 0, "mean": 0, "directli": 0, "instead": 0, "thing": 0, "becaus": 0, "want": 0, "note": 0, "descript": 0, "For": [0, 1], "could": 0, "written": 0, "restructuredtext": 0, "built": 0, "sphinx": 0, "prefer": 0, "visual": 0, "studio": 0, "recommend": 0, "take": 0, "few": 0, "minut": 0, "familiar": 0, "yourself": 0, "structur": 0, "split": 0, "differ": 0, "section": 0, "each": 0, "virtual": [], "environ": 0, "work": 0, "venv": [], "env": [], "hold": [], "tell": [], "On": [], "linux": 0, "maco": [], "bin": [], "activ": [], "window": [], "script": [], "flit": [], "symlink": [], "b": [], "html": 0, "_build": 0, "1": [0, 1], "load": 0, "pickl": 0, "mo": 0, "target": 0, "0": 0, "po": 0, "out": [0, 1], "date": 0, "ad": 0, "remov": 0, "read": [], "look": 0, "outdat": 0, "none": 0, "found": 0, "consist": [], "prepar": [], "output": [], "gener": [], "indic": [], "genindex": [], "py": [], "modindexdon": [], "highlight": [], "fictitious_plai": [], "addit": [], "searchdon": [], "imag": [], "_static": [], "png": [], "static": [], "extra": [], "dump": [], "english": [], "en": [], "inventori": [], "succeed": 0, "browser": 0, "typic": 0, "platform": 0, "like": 0, "provid": [], "ssh": 0, "protocol": 0, "past": 0, "just": 0, "httpsgit": 0, "117": 0, "14": 0, "105": 0, "9": [0, 1], "3": [0, 1], "63": 0, "43": 0, "crucial": 0, "It": 0, "user": 0, "understand": 0, "folder": 0, "via": 0, "v5": 0, "tab": 0, "would": 0, "some": 0, "tag": 0, "rememb": 0, "docstr": 0, "describ": 0, "what": 0, "doe": 0, "format": 0, "def": 0, "function_nam": 0, "argument": 0, "paramet": 0, "return": 0, "valu": 0, "return_valu": [], "autofunct": [], "automodul": [], "member": [], "undoc": [], "show": [], "inherit": [], "automethod": [], "pytest": 0, "session": 0, "8": [0, 1], "5": [0, 1], "6": [0, 1], "pluggi": 0, "13": 0, "rootdir": 0, "home": 0, "collect": 0, "item": 0, "ran": 0, "01": 0, "new_funct": [], "explain": [], "toctre": [], "maxdepth": [], "examplefuct": [], "root": 0, "tou": 0, "lwz": 1, "unsorted_list": 1, "4": 1, "10": 1, "7": 1, "sorted_list": 1, "merge_sort": 1, "current": [], "implemnt": [], "wuthin": [], "submodul": [], "inspect": [], "content": [], "more": 1, "choos": 0, "onwer": 0, "enhanc": 0, "No": 0, "did": 0}, "objects": {}, "objtypes": {}, "objnames": {}, "titleterms": {"welcom": 1, "listwiz": 1, "s": 1, "document": [0, 1], "indic": 1, "tabl": 1, "make": 0, "contribut": 0, "fork": 0, "repositori": 0, "clone": 0, "repository\u00e5": [], "creat": 0, "branch": 0, "modifi": 0, "check": 0, "modif": 0, "implement": 0, "function": 0, "run": [], "test": 0, "suit": [], "commit": 0, "chang": 0, "push": 0, "github": 0, "open": 0, "pull": 0, "request": 0, "further": 0, "exampl": [], "how": [], "To": [], "your": 0, "packag": [], "submodul": [], "inspect": [], "modul": [], "replac": [], "sort": [], "content": []}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 6, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 56}}) \ No newline at end of file +Search.setIndex({"docnames": ["contributing/branching", "contributing/contributing_docs", "contributing/contributing_function", "contributing/contributing_test", "contributing/forking", "contributing/index", "contributing/installation", "contributing/pull_request", "index", "installation/index"], "filenames": ["contributing/branching.rst", "contributing/contributing_docs.rst", "contributing/contributing_function.rst", "contributing/contributing_test.rst", "contributing/forking.rst", "contributing/index.rst", "contributing/installation.rst", "contributing/pull_request.rst", "index.rst", "installation/index.rst"], "titles": ["2. Creating a branch", "3. Contributing to the documentation", "5. Contributing a new function", "4. Contributing a test", "1. Forking and Cloning the repository", "Make a Contribution to listwiz", "<no title>", "6. Pushing to Github and Opening a Pull Request", "Welcome to listwiz\u2019s documentation!", "Installation Guide"], "terms": {"befor": [0, 2, 3, 5, 7], "we": [0, 4, 5, 7, 9], "start": [0, 2, 3, 5, 7], "make": [0, 1, 4, 8, 9], "chang": [0, 4, 5, 9], "sourc": [0, 1, 2, 3, 4, 5, 7, 9], "code": [0, 1, 2, 3, 4, 5, 7, 9], "first": [0, 1, 2, 3, 5, 7, 9], "thing": [0, 1, 5], "do": [0, 1, 2, 3, 4, 5, 7], "new": [0, 3, 5, 8], "thi": [0, 1, 2, 3, 4, 5, 7, 8, 9], "becaus": 0, "want": [0, 1, 2, 3, 4, 5, 7, 9], "keep": 0, "ar": [0, 1, 2, 3, 5, 7, 9], "about": [0, 8], "separ": [0, 1], "from": [0, 1, 2, 3, 4, 7], "main": [0, 1, 7], "To": [0, 1, 2, 3, 4, 5, 7, 9], "directori": [0, 1, 2, 3, 9], "cd": [0, 1, 9], "hitchhik": [0, 2, 3, 4, 9], "guid": [0, 2, 3, 4, 8], "contribut": [0, 4, 8, 9], "open": [0, 1, 2, 3, 4, 5, 8, 9], "now": [0, 1, 4, 5, 7], "type": [0, 2, 4], "follow": [0, 1, 2, 3, 4, 5, 9], "git": [0, 1, 2, 3, 4, 5, 7, 9], "name": [0, 1, 2, 3, 7], "note": [0, 4], "should": [0, 1, 2, 3, 4, 7], "descript": [0, 2, 3], "you": [0, 1, 2, 3, 4, 5, 7, 8, 9], "go": [0, 7], "For": [0, 5], "exampl": [0, 5], "add": [0, 1, 2, 3, 7], "function": [0, 5, 8], "could": 0, "implement": [0, 2, 3, 5], "checkout": 0, "In": [1, 2, 5, 8, 9], "issu": [1, 2, 3, 5], "section": [1, 2, 3, 5], "project": [1, 2, 3, 4, 5, 7, 8, 9], "can": [1, 2, 3, 5, 7], "find": [1, 2, 3, 5, 8], "label": [1, 2, 3], "These": [1, 5], "relat": 1, "choos": [1, 2, 3, 4, 5], "one": 1, "work": [1, 2, 3, 5], "The": [1, 2, 3, 4, 5], "crucial": 1, "part": [1, 5], "ani": [1, 7, 9], "It": 1, "help": 1, "user": [1, 2], "understand": [1, 2], "how": [1, 2, 5], "us": [1, 2, 3, 4, 5, 9], "softwar": [1, 2, 7], "all": [1, 2, 3, 7], "file": [1, 2, 3, 7, 9], "doc": 1, "written": [1, 2, 3], "restructuredtext": 1, "built": 1, "sphinx": 1, "order": 1, "modifi": [1, 7, 9], "need": [1, 2, 3, 4, 5, 9], "your": [1, 4, 5, 7, 9], "prefer": 1, "editor": [1, 2, 3, 7], "If": [1, 5, 9], "have": [1, 2, 3, 4, 5, 7], "visual": 1, "studio": 1, "recommend": [1, 9], "take": [1, 5], "few": [1, 5], "minut": 1, "familiar": [1, 2, 3], "yourself": [1, 2, 3], "structur": [1, 2, 3], "index": [1, 8], "rst": 1, "which": [1, 7], "includ": [1, 2, 3, 5, 7], "other": [1, 5, 7], "split": 1, "differ": 1, "each": [1, 5], "folder": [1, 2, 3], "build": [1, 7], "download": [1, 4], "via": 1, "pip": [1, 9], "python": [1, 2, 3], "m": 1, "instal": [1, 8], "navig": [1, 2, 3, 4, 5, 7, 9], "run": [1, 2, 3, 5, 7, 9], "command": [1, 2, 3, 4, 7, 9], "html": 1, "v5": 1, "0": [1, 2, 3, 4], "2": [1, 2, 3, 5, 7, 8], "load": 1, "pickl": 1, "environ": 1, "done": [1, 2, 3, 4, 7, 9], "mo": 1, "target": 1, "po": 1, "out": 1, "date": 1, "updat": [1, 7], "ad": 1, "remov": 1, "look": [1, 4], "outdat": 1, "none": 1, "found": 1, "succeed": 1, "page": [1, 8], "_build": 1, "browser": 1, "see": [1, 7], "local": [1, 7], "made": 1, "onc": [1, 2, 3, 4, 5, 7], "them": [1, 2, 3, 8], "stage": [1, 2, 3, 7], "tou": [1, 2, 3, 7], "text": [1, 2, 3, 7], "where": [1, 2, 3, 4, 7, 9], "write": [1, 2, 3, 5, 7], "titl": [1, 2, 3, 7], "messag": [1, 2, 3, 7], "an": [1, 2, 3, 5], "necessari": 1, "area": [1, 2, 3], "tab": [2, 3, 5], "repositori": [2, 3, 5, 7, 8, 9], "would": [2, 3, 5], "like": [2, 3, 4, 5], "some": [2, 3], "tag": [2, 3], "enhanc": [2, 3], "rememb": [2, 5], "docstr": [2, 3], "describ": 2, "what": [2, 5], "doe": 2, "import": [2, 8], "format": 2, "def": 2, "function_nam": 2, "argument": 2, "paramet": 2, "return": 2, "valu": 2, "suit": [2, 3, 5], "pytest": [2, 3], "root": [2, 3], "session": [2, 3], "platform": [2, 3, 5], "linux": [2, 3], "3": [2, 3, 4, 5, 8], "8": [2, 3, 8], "6": [2, 3, 5, 8], "pluggi": [2, 3], "13": [2, 3], "1": [2, 3, 5, 8, 9], "rootdir": [2, 3], "home": [2, 3], "nikoleta": [2, 3, 4], "collect": [2, 3], "item": [2, 3], "ran": [2, 3], "01": [2, 3], "5": [3, 5, 8], "document": [3, 5, 7], "most": [4, 8], "protect": 4, "github": [4, 5, 8, 9], "mean": 4, "cannot": 4, "directli": 4, "instead": [4, 9], "creat": [4, 5, 8, 9], "copi": [4, 5, 7, 9], "under": [4, 7], "own": 4, "account": [4, 5, 7], "process": [4, 7], "call": 4, "http": [4, 5, 9], "com": [4, 5, 9], "v3": 4, "click": [4, 7], "button": [4, 7], "Then": [4, 7, 9], "onwer": 4, "comput": [4, 5, 7, 9], "address": 4, "clipboard": 4, "ssh": 4, "protocol": 4, "line": 4, "tool": 4, "past": 4, "just": 4, "usernam": [4, 9], "replac": [4, 9], "httpsgit": 4, "remot": 4, "enumer": 4, "object": 4, "117": 4, "count": 4, "100": 4, "compress": 4, "94": 4, "total": 4, "delta": 4, "14": 4, "reus": 4, "105": 4, "9": [4, 8], "pack": 4, "receiv": 4, "63": 4, "mib": 4, "43": 4, "s": [4, 9], "resolv": 4, "tutori": 5, "learn": 5, "typic": 5, "host": 5, "gitlab": 5, "manag": 5, "educ": 5, "appli": 5, "specif": 5, "here": 5, "more": [5, 9], "initi": 5, "step": 5, "fork": [5, 8, 9], "bring": 5, "clone": [5, 8, 9], "readi": 5, "There": 5, "sever": 5, "task": 5, "test": [5, 7, 8], "nagiv": 5, "branch": [5, 7, 8], "4": [5, 8], "inform": [5, 8], "well": 5, "checklist": 5, "complet": 5, "compil": 5, "commit": [5, 7], "ask": 5, "develop": [5, 9], "instruct": 5, "push": [5, 8], "pull": [5, 8], "request": [5, 8], "thu": 5, "summari": 5, "summaris": 5, "check": [5, 7], "modif": 5, "further": 5, "send": 7, "back": 7, "origin": 7, "listwiz": 7, "One": 7, "so": 7, "merg": 7, "compar": 7, "number": 7, "autom": 7, "variou": 7, "also": 7, "viewabl": 7, "version": 7, "correspond": 7, "detail": [7, 9], "No": 7, "review": 7, "requir": 7, "did": 7, "similarli": 7, "automat": 7, "contributor": 7, "list": [7, 8], "final": 7, "might": 7, "repeat": 7, "itself": 7, "eventu": 7, "allow": 8, "handl": 8, "sort": 8, "longest": 8, "increas": 8, "streak": 8, "identifi": 8, "frequent": 8, "occur": 8, "element": 8, "lwz": 8, "unsorted_list": 8, "10": 8, "7": 8, "sorted_list": 8, "merge_sort": 8, "modul": 8, "search": 8, "packag": 9, "obtain": 9, "refer": 9, "after": 9, "termin": 9, "place": 9, "actual": 9, "next": 9, "mode": 9, "e": 9, "why": 9, "plan": 9, "immedi": 9, "reflect": 9, "without": 9, "reinstal": 9}, "objects": {}, "objtypes": {}, "objnames": {}, "titleterms": {"2": 0, "creat": 0, "branch": 0, "3": 1, "contribut": [1, 2, 3, 5], "document": [1, 2, 8], "check": 1, "modif": [1, 7], "commit": [1, 2, 3], "chang": [1, 2, 3, 7], "checklist": [1, 2, 3], "5": 2, "new": 2, "function": [2, 3], "your": [2, 3], "test": [2, 3], "4": 3, "1": 4, "fork": 4, "clone": 4, "repositori": 4, "make": [5, 7], "listwiz": [5, 8], "6": 7, "push": 7, "github": 7, "open": 7, "pull": 7, "request": 7, "further": 7, "welcom": 8, "s": 8, "tabl": 8, "content": 8, "indic": 8, "instal": 9, "guid": 9}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 6, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 56}}) \ No newline at end of file diff --git a/docs/build/html/source/listwiz.html b/docs/build/html/source/listwiz.html deleted file mode 100644 index 07631e1..0000000 --- a/docs/build/html/source/listwiz.html +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - - listwiz package — listwiz 0.0.1 documentation - - - - - - - - - - - - - - - - - -
- - -
- -
-
-
- -
-
-
-
- -
-

listwiz package

-
-

Submodules

-
-
-

listwiz.inspect module

-
-
-

listwiz.replace module

-
-
-

listwiz.sorting module

-
-
-

Module contents

-
-
- - -
-
-
- -
- -
-

© Copyright 2024, Nikoleta E. Glynatsi, Sebastian Berg.

-
- - Built with Sphinx using a - theme - provided by Read the Docs. - - -
-
-
-
-
- - - - \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index 13a90df..fe569a7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -30,7 +30,7 @@ # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = [ +extensions = [ 'sphinx.ext.autosectionlabel' ] # Add any paths that contain templates here, relative to this directory. diff --git a/docs/contributing/branching.rst b/docs/contributing/branching.rst new file mode 100644 index 0000000..2e4c8c2 --- /dev/null +++ b/docs/contributing/branching.rst @@ -0,0 +1,23 @@ +.. _Branching: + +2. Creating a branch +--------------------- + +Before we start making changes to the source code, the first thing we will do is +create a new branch. This is because we want to keep the changes we are about to +make separate from the main source code. To do this, first change directory into +the source code:: + + $ cd a-hitchhikers-guide-to-contributing-to-open-source + +Now, to create a new branch, type the following:: + + $ git branch the-name-of-the-branch + +Note that the name of the branch should be descriptive of the changes you are +going to make. For example, if you are going to add a new function to the source +code, you could name the branch :code:`implementing-new-function`. + +Now checkout to that branch:: + + $ git checkout the-name-of-the-branch \ No newline at end of file diff --git a/docs/contributing/contributing_docs.rst b/docs/contributing/contributing_docs.rst new file mode 100644 index 0000000..c872e2d --- /dev/null +++ b/docs/contributing/contributing_docs.rst @@ -0,0 +1,89 @@ +.. |uncheck| raw:: html + + + +.. _ContributingDocs: + +3. Contributing to the documentation +------------------------------------- + +In the issues section of the project, you can find issues that are labeled +:code:`documentation`. These are issues that are related to the documentation of +the project. You can choose one of these issues to work on. + +The documentation is a crucial part of any open-source project. It helps users +understand how to use the software and how to contribute to it. + +All the files for the documentation are in the :code:`docs` directory. The +documentation is written in `reStructuredText +`_. The +documentation is built using `Sphinx `_. + +In order to modify the documentation, you need to change the files in the +:code:`docs` directory. Open the project in your preferred editor. If you do not +have a preferred editor `Visual Studio Code `_ is +recommended. + +Take a few minutes to familiarize yourself with the structure of the +documentation. The main file for the documentation is :code:`index.rst` which is +in the :code:`docs` directory. This file includes all the other files in the +documentation. The documentation is split into different sections, each of which +is in a separate folder in the :code:`docs` directory. + + +Checking the modification +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +To build the documentation, the first thing you need to do is to download +`Sphinx `_. You can do this via `pip`:: + + $ python -m pip install sphinx + +To build the documentation navigate to the :code:`docs` directory:: + + $ cd docs + +and run the command:: + + $ make html + Running Sphinx v5.0.2 + loading pickled environment... done + building [mo]: targets for 0 po files that are out of date + building [html]: targets for 0 source files that are out of date + updating environment: 0 added, 0 changed, 0 removed + looking for now-outdated files... none found + no targets are out of date. + build succeeded. + + The HTML pages are in build/html. + +You can open :code:`_build/html/index.html` in a browser to see the +documentation locally which should include the changes you made. + + +Committing the change +^^^^^^^^^^^^^^^^^^^^^ + +Once you are done with your changes, you need to commit them. First, you need to +**stage** the files you have changed. To do this, run the following command:: + + $ git add + +Do this for all the files you have changed. Once you have staged all the files, +you can commit them:: + + $ git commit + +This will open a text editor where you can write your commit title and message. + + +Checklist +^^^^^^^^^ + +| |uncheck| Choose an issue labeled :code:`documentation` from the issues section. +| |uncheck| Familiarize yourself with the structure of the documentation. +| |uncheck| Make the necessary changes to the documentation. +| |uncheck| Build the documentation using `Sphinx `_. +| |uncheck| Check the changes you made by opening :code:`_build/html/index.html` in a browser. +| |uncheck| Add the changes to the staging area. +| |uncheck| Commit the changes. \ No newline at end of file diff --git a/docs/contributing/contributing_function.rst b/docs/contributing/contributing_function.rst new file mode 100644 index 0000000..f426889 --- /dev/null +++ b/docs/contributing/contributing_function.rst @@ -0,0 +1,84 @@ +.. |uncheck| raw:: html + + + +.. _ContributingFunction: + +5. Contributing a new function +------------------------------- + +Navigate to the issues tab of the repository and find an issue that you would +like to work on. Some of these issues are tagged as :code:`enhancement`. The +issue will have a description of the function that needs to be implemented, and +where the function code should be included. + +In your function you need to remember to include a docstring that describes what +the function does. This is important for users of the software to understand how +to use the function. The docstring should be in the following format:: + + def function_name(arguments): + """ + Description of the function. + + Parameters + ---------- + arguments : type + Description of the argument. + + Returns + ------- + type + Description of the return value. + """ + + # code for the function + + +Documenting your function +^^^^^^^^^^^^^^^^^^^^^^^^^^ + + +Testing your function +^^^^^^^^^^^^^^^^^^^^^ + +Before you commit your changes, you need to test your function. To do this, you +need to run the test suite. The test suite is in the :code:`tests` directory. +The test suite is written using `pytest `_. +To run the test suite, run the command from the root of the project folder:: + + $ pytest tests + ============================= test session starts ============================== + platform linux -- Python 3.8.5, pytest-6.2.2, pluggy-0.13.1 + rootdir: /home/nikoleta/Documents/a-hitchhikers-guide-to-contributing-to-open-source + collected 0 items + + ============================== no tests ran in 0.01s ============================== + + +Committing the change +^^^^^^^^^^^^^^^^^^^^^ + +Once you are done with your changes, you need to commit them. First, you need to +**stage** the files you have changed. To do this, run the following command:: + + $ git add + +Do this for all the files you have changed. Once you have staged all the files, +you can commit them:: + + $ git commit + +This will open a text editor where you can write your commit title and message. + + +Checklist +^^^^^^^^^ + +| |uncheck| Choose an issue labeled :code:`enhancement` from the issues section. +| |uncheck| Familiarize yourself with the structure of the source code. +| |uncheck| Implement the new function. +| |uncheck| Include a docstring in the function. +| |uncheck| Implement a test for your new function. +| |uncheck| Test the function using the test suite. +| |uncheck| Add the changes to the staging area. +| |uncheck| Commit the changes. \ No newline at end of file diff --git a/docs/contributing/contributing_test.rst b/docs/contributing/contributing_test.rst new file mode 100644 index 0000000..b89a524 --- /dev/null +++ b/docs/contributing/contributing_test.rst @@ -0,0 +1,58 @@ +.. |uncheck| raw:: html + + + +.. _ContributingTest: + +4. Contributing a test +---------------------- + +Navigate to the issues tab of the repository and find an issue that you would +like to work on. Some of these issues are tagged as :code:`enhancement`. The +issue will have a description of the function that needs to be implemented, and +where the function code should be included. + +Testing your function +^^^^^^^^^^^^^^^^^^^^^ + +Before you commit your changes, you need to test your function. To do this, you +need to run the test suite. The test suite is in the :code:`tests` directory. +The test suite is written using `pytest `_. +To run the test suite, run the command from the root of the project folder:: + + $ pytest tests + ============================= test session starts ============================== + platform linux -- Python 3.8.5, pytest-6.2.2, pluggy-0.13.1 + rootdir: /home/nikoleta/Documents/a-hitchhikers-guide-to-contributing-to-open-source + collected 0 items + + ============================== no tests ran in 0.01s ============================== + + +Committing the change +^^^^^^^^^^^^^^^^^^^^^ + +Once you are done with your changes, you need to commit them. First, you need to +**stage** the files you have changed. To do this, run the following command:: + + $ git add + +Do this for all the files you have changed. Once you have staged all the files, +you can commit them:: + + $ git commit + +This will open a text editor where you can write your commit title and message. + + +Checklist +^^^^^^^^^ + +| |uncheck| Choose an issue labeled :code:`enhancement` from the issues section. +| |uncheck| Familiarize yourself with the structure of the source code. +| |uncheck| Implement the new function. +| |uncheck| Include a docstring in the function. +| |uncheck| Implement a test for your new function. +| |uncheck| Test the function using the test suite. +| |uncheck| Add the changes to the staging area. +| |uncheck| Commit the changes. \ No newline at end of file diff --git a/docs/contributing/forking.rst b/docs/contributing/forking.rst new file mode 100644 index 0000000..9fd1b25 --- /dev/null +++ b/docs/contributing/forking.rst @@ -0,0 +1,47 @@ +.. _Forking: + +1. Forking and Cloning the repository +------------------------------------- + +Forking the repository +^^^^^^^^^^^^^^^^^^^^^^ + +Most projects have protected GitHub repositories, meaning you cannot make +changes directly to the source code. Instead, you need to create a copy of the +source code under your own GitHub account and then make changes to that copy. +This process is called a **fork**. To do this, navigate to the GitHub repository +of the project +(https://github.com/Nikoleta-v3/a-hitchhikers-guide-to-contributing-to-open-source) +and click the :code:`Fork` button. Then choose your GitHub account as the +**onwer** and click on :code:`Create fork`. + + +.. image:: /_static/forking.png + + +Cloning the repository +^^^^^^^^^^^^^^^^^^^^^^ + +Once we have a fork of the repository on **your** Github account, create a copy +of it to your computer. This is called cloning. Do this by clicking the +:code:`Code` button and copying the address of the repository to your clipboard: + +.. image:: /_static/cloning.png + +Note that we want to copy the address of the repository using the `SSH` +protocol. Now, open your command line tool and type `git clone`, then paste the +address you just copied. The command should look like the following, where +`` is replaced with your GitHub username:: + + + $ git clone httpsgit@github.com:/a-hitchhikers-guide-to-contributing-to-open-source.git + +This will download the source code to your computer:: + + Cloning into 'a-hitchhikers-guide-to-contributing-to-open-source'... + remote: Enumerating objects: 117, done. + remote: Counting objects: 100% (117/117), done. + remote: Compressing objects: 100% (94/94), done. + remote: Total 117 (delta 14), reused 105 (delta 9), pack-reused 0 (from 0) + Receiving objects: 100% (117/117), 3.63 MiB | 3.43 MiB/s, done. + Resolving deltas: 100% (14/14), done. \ No newline at end of file diff --git a/docs/contributing/index.rst b/docs/contributing/index.rst index 5fcb7cd..d13494b 100644 --- a/docs/contributing/index.rst +++ b/docs/contributing/index.rst @@ -1,254 +1,51 @@ -Make a contribution to the documentation -============================================ +Make a Contribution to `listwiz` +================================ -In this tutorial we will learn how to make a contribution to `listwiz`. +In this tutorial, we will learn how to contribute to `listwiz`. -Open source projects are typically hosted on platforms like GitHub, GitLab, or +Open-source projects are typically hosted on platforms like GitHub, GitLab, or others, with the source code managed using Git. In this tutorial, we will use GitHub as an example. To make a contribution, you need to have a GitHub account. You can create an account by navigating to GitHub: http://github.com. If you are in education, you can apply for a specific education account here: https://education.github.com. +Now that you have your account, there are a few more initial steps that you will +need to take before you can start contributing to the project. The first step is +to create a fork of the project and bring a copy of the project to your +computer: -Forking the repository ----------------------- +- :ref:`Forking` -Most projects have protected GitHub repositories, meaning you cannot make -changes directly to the source code. Instead, you need to create a copy of the -source code under your own GitHub account and then make changes to that copy. -This process is called a **fork**. To do this, navigate to the GitHub repository -of the project -(https://github.com/Nikoleta-v3/a-hitchhikers-guide-to-contributing-to-open-source) -and click the :code:`Fork` button. Then choose your GitHub account as the -**onwer** and click on :code:`Create fork`. +Now you are ready to start contributing. There are several tasks that you can +do, such as including documentation, writing tests, or implementing functions. +You can nagivate to the issues tab of the repository and find an issue that you +would like to work on. Once you choose what you want to work on, remember to +create a branch before you start implementing. +- :ref:`Branching` +- :ref:`ContributingDocs` +- :ref:`ContributingTest` +- :ref:`ContributingFunction` -.. image:: /_static/forking.png +In each section, you will find information on how to implement each step, as +well as a checklist of things you need to complete. These include compiling the +documentation, running the test suite, and committing your changes! -Cloning the repository ----------------------- +Now you are ready to ask for your new developed code to be part of the source +code of the project! For that you need to follow the instructions: -Once we have a fork of the repository on **your** Github account, create a copy -of it to your computer. This is called cloning. Do this by clicking the -:code:`Code` button and copying the address of the repository to your clipboard: +- :ref:`PushingAndPullRequest` -.. image:: /_static/cloning.png +Thus as a summary the steps you have to take can be summarised as follows: -Note that we want to copy the address of the repository using the `SSH` -protocol. Now, open your command line tool and type `git clone`, then paste the -address you just copied. The command should look like the following, where -`` is replaced with your GitHub username:: +.. toctree:: + :maxdepth: 2 + forking.rst + branching.rst + contributing_docs.rst + contributing_test.rst + contributing_function.rst + pull_request.rst - $ git clone httpsgit@github.com:/a-hitchhikers-guide-to-contributing-to-open-source.git - -This will download the source code to your computer:: - - Cloning into 'a-hitchhikers-guide-to-contributing-to-open-source'... - remote: Enumerating objects: 117, done. - remote: Counting objects: 100% (117/117), done. - remote: Compressing objects: 100% (94/94), done. - remote: Total 117 (delta 14), reused 105 (delta 9), pack-reused 0 (from 0) - Receiving objects: 100% (117/117), 3.63 MiB | 3.43 MiB/s, done. - Resolving deltas: 100% (14/14), done. - -Creating a branch ------------------ - -Before we start making changes to the source code, the first thing we will do is -create a new branch. This is because we want to keep the changes we are about to -make separate from the main source code. To do this, first change directory into -the source code:: - - $ cd a-hitchhikers-guide-to-contributing-to-open-source - -Now, to create a new branch, type the following:: - - $ git branch the-name-of-the-branch - -Note that the name of the branch should be descriptive of the changes you are -going to make. For example, if you are going to add a new function to the source -code, you could name the branch :code:`implementing-new-function`. - -Now checkout to that branch:: - - $ git checkout the-name-of-the-branch - - -Modifying the documentation ---------------------------- - -One set of changes you can make to the source code is to the documentation. The -documentation is a crucial part of any open-source project. It helps users -understand how to use the software and how to contribute to it. - -All the files for the documentation are in the :code:`docs` directory. The -documentation is written in `reStructuredText -`_. The -documentation is built using `Sphinx `_. - -In order to modify the documentation, you need to change the files in the -:code:`docs` directory. Open the project in your preferred editor. If you do not -have a preferred editor `Visual Studio Code `_ is -recommended. - -Take a few minutes to familiarize yourself with the structure of the -documentation. The main file for the documentation is :code:`index.rst` which is -in the :code:`docs` directory. This file includes all the other files in the -documentation. The documentation is split into different sections, each of which -is in a separate folder in the :code:`docs` directory. - - -Checking the modification -^^^^^^^^^^^^^^^^^^^^^^^^^^ - -To build the documentation, the first thing you need to do is to download -`Sphinx `_. You can do this via `pip`:: - - $ python -m pip install sphinx - -To build the documentation navigate to the :code:`docs` directory:: - - $ cd docs - -and run the command:: - - $ make html - Running Sphinx v5.0.2 - loading pickled environment... done - building [mo]: targets for 0 po files that are out of date - building [html]: targets for 0 source files that are out of date - updating environment: 0 added, 0 changed, 0 removed - looking for now-outdated files... none found - no targets are out of date. - build succeeded. - - The HTML pages are in build/html. - -You can open :code:`_build/html/index.html` in a browser to see the -documentation locally which should include the changes you made. - - -Implementing a function ------------------------- - -Navigate to the issues tab of the repository and find an issue that you would -like to work on. Some of these issues are tagged as :code:`enhancement`. The issue -will have a description of the function that needs to be implemented, and where -the function code should be included. - -In your function you need to remember to include a docstring that describes what -the function does. This is important for users of the software to understand how -to use the function. The docstring should be in the following format:: - - def function_name(arguments): - """ - Description of the function. - - Parameters - ---------- - arguments : type - Description of the argument. - - Returns - ------- - type - Description of the return value. - """ - - # code for the function - - -Documenting your function -^^^^^^^^^^^^^^^^^^^^^^^^^^ - - -Testing your function -^^^^^^^^^^^^^^^^^^^^^ - -Before you commit your changes, you need to test your function. To do this, you -need to run the test suite. The test suite is in the :code:`tests` directory. -The test suite is written using `pytest `_. -To run the test suite, run the command from the root of the project folder:: - - $ pytest tests - ============================= test session starts ============================== - platform linux -- Python 3.8.5, pytest-6.2.2, pluggy-0.13.1 - rootdir: /home/nikoleta/Documents/a-hitchhikers-guide-to-contributing-to-open-source - collected 0 items - - ============================== no tests ran in 0.01s ============================== - - -Committing the change ---------------------- - -Once you are done with your changes, you need to commit them. First, you need to -**stage** the files you have changed. To do this, run the following command:: - - $ git add - -Do this for all the files you have changed. Once you have staged all the files, -you can commit them:: - - $ git commit - -This will open a text editor where you can write your commit title and message. - - -Pushing the change to Github ----------------------------- - -Now that all that is done, you are going to send the changes back to your copy -of the source code on Github:: - - $ git push origin the-name-of-the-branch - - -Opening a Pull Request ----------------------- - -You now have 2 copies of the modified source code of the `listwiz` project. One -locally on your computer, the other under your Github account. So first you will -push your locally modified source code to your Github account. To do this run -the command:: - - $ git push origin the-name-of-the-branch - -Now we want to merge the changes from your Github account to the main source -code of `listwiz`. To do this, open a Pull Request. To do this, navigate to the -repository on your Github account. You should see a :code:`Compare and Pull -Request` button: - -.. image:: /_static/compare_button.png - -Making further modifications ----------------------------- - -Once a Pull Request is opened, a number of automated checks will start. This -will check the various software tests but also build a viewable version of the -documentation. - -You can click on the corresponding :code:`details` button to see any of these. - - -No that your modification will also be reviewed. To make any required changes, -**modify the files** in your computer as you did before. - -Then stage and commit the files:: - - $ git add - $ git commit - -This will open a text editor where you can write your commit title and message -(similarly to before). - -Once this is done, push the code to Github which will automatically update the -pull request:: - - $ git push origin add-name-to-contributors-list - -This final process of making further modifications might repeat itself and -eventually the Pull Request will be **merged** and your changes included in the -main version of the source code. \ No newline at end of file diff --git a/docs/contributing/installation.rst b/docs/contributing/installation.rst new file mode 100644 index 0000000..e69de29 diff --git a/docs/contributing/pull_request.rst b/docs/contributing/pull_request.rst new file mode 100644 index 0000000..4abddd0 --- /dev/null +++ b/docs/contributing/pull_request.rst @@ -0,0 +1,60 @@ +.. _PushingAndPullRequest: + +6. Pushing to Github and Opening a Pull Request +=============================================== + +Pushing the change to Github +---------------------------- + +Now that all that is done, you are going to send the changes back to your copy +of the source code on Github:: + + $ git push origin the-name-of-the-branch + + +Opening a Pull Request +---------------------- + +You now have 2 copies of the modified source code of the `listwiz` project. One +locally on your computer, the other under your Github account. So first you will +push your locally modified source code to your Github account. To do this run +the command:: + + $ git push origin the-name-of-the-branch + +Now we want to merge the changes from your Github account to the main source +code of `listwiz`. To do this, open a Pull Request. To do this, navigate to the +repository on your Github account. You should see a :code:`Compare and Pull +Request` button: + +.. image:: /_static/compare_button.png + +Making further modifications +---------------------------- + +Once a Pull Request is opened, a number of automated checks will start. This +will check the various software tests but also build a viewable version of the +documentation. + +You can click on the corresponding :code:`details` button to see any of these. + + +No that your modification will also be reviewed. To make any required changes, +**modify the files** in your computer as you did before. + +Then stage and commit the files:: + + $ git add + $ git commit + +This will open a text editor where you can write your commit title and message +(similarly to before). + +Once this is done, push the code to Github which will automatically update the +pull request:: + + $ git push origin add-name-to-contributors-list + +This final process of making further modifications might repeat itself and +eventually the Pull Request will be **merged** and your changes included in the +main version of the source code. \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index e6cd801..be79f3e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -11,13 +11,13 @@ streaks, and identify the most frequently occurring elements:: >>> sorted_list [1, 2, 3, 4, 5, 6, 7, 8, 9, 10] - -The purpose of this package is to help you learn how to contribute to open -source projects. For more information, check out the tutorial: +Table of Contents +================= .. toctree:: - :maxdepth: 1 + :maxdepth: 2 + installation/index.rst contributing/index.rst Indices and tables diff --git a/docs/installation/index.rst b/docs/installation/index.rst new file mode 100644 index 0000000..c991b97 --- /dev/null +++ b/docs/installation/index.rst @@ -0,0 +1,39 @@ +Installation Guide +================== + +To install the package, you first need to obtain a copy of the project's +repository on your computer. This is done by cloning the repository. + +We recommend that you first create a fork of the repository (refer to +:ref:`Forking` for more details). + +After forking the repository, clone your fork to your computer by running the +following command in your terminal after navigating to the directory where you +want to place the project:: + + + $ git clone https://github.com//a-hitchhikers-guide-to-contributing-to-open-source.git + + +Replace `` with your actual GitHub username. Next, +navigate to the project directory:: + + + $ cd a-hitchhikers-guide-to-contributing-to-open-source + + +Then, install the package by running the following command:: + + $ pip install . + + +If you want to install the package in development mode, use the following +command instead:: + + + $ pip install -e . + + +*Why install in development mode?* Development mode is useful if you plan to +modify the code. In this mode, any changes you make to the source files are +immediately reflected in the installed package, without needing to reinstall it. \ No newline at end of file From ffde84c237a9c51cb9051ec029a48be533d52544 Mon Sep 17 00:00:00 2001 From: Nikoleta-v3 Date: Thu, 22 Aug 2024 21:57:48 +0200 Subject: [PATCH 4/6] updating readme --- README.md | 37 +++++++++++++++++++++++++++++++++++-- 1 file changed, 35 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 17bf72f..cd5c3b8 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,35 @@ -# a-hitchhikers-guide-to-contributing-to-open-source -Open source material that will help you transition from user to contributor. Learn to use Git, document and test code, improve documentation, and master GitHub. +# A Hitchhiker's Guide to Contributing to Open Source + +Open source material that will help you transition from user to contributor. +Learn to use Git, document and test code, improve documentation, and master +GitHub. + +This repository contains the files necessary for a mock Python package called +`listwiz`. It is a package that allows us to handle and manipulate lists. + +Any Python project has its own repository and slightly different style, but many +things remain the same across projects. This project follows the recommended +structure. Below, you can see several files and folders along with their +purposes: + +- `.github/workflows`: This directory contains files for running Continuous + Integration (CI). +- `docs`: Contains all necessary files for the online documentation of the + package. This package is built using Sphinx, and you can see the online + documentation here: +- `src`: The folder with the source code of the package. Note that the + convention is to name this folder `src/`. In this case, it's + `src/listwiz`. Inside, you will find several Python files and an `__init__.py` + file at the root. +- `tests`: This folder contains all the tests for the source code. We usually + aim for each file in `src` to have an associated test file in the `tests` + folder. +- `.gitignore`: This file lists all the files we want Git to ignore. Our Python + package generates a lot of auxiliary files, and examples of these are listed + here. +- `README.md`: A file that allows us to deploy the online documentation. +- `setup.py`: The file that is run when we install the package. +- `LICENSE`: The file that contains the license information. +- `CONTRIBUTING.rst`: The file with the contributing guidelines. + +Installation notes. \ No newline at end of file From 0def92b8682b09b9d382bda721282c611f795c74 Mon Sep 17 00:00:00 2001 From: Nikoleta-v3 Date: Thu, 22 Aug 2024 22:07:06 +0200 Subject: [PATCH 5/6] adding missing sections to docs --- .../contributing_function.doctree | Bin 12916 -> 15008 bytes .../contributing/contributing_test.doctree | Bin 11349 -> 11082 bytes docs/build/doctrees/environment.pickle | Bin 27975 -> 29733 bytes docs/build/doctrees/index.doctree | Bin 6790 -> 6032 bytes .../contributing_function.rst.txt | 15 +++++++ .../contributing/contributing_test.rst.txt | 40 +++++++++-------- docs/build/html/_sources/index.rst.txt | 5 --- .../contributing/contributing_function.html | 15 +++++++ .../html/contributing/contributing_test.html | 41 +++++++++--------- docs/build/html/contributing/index.html | 5 ++- docs/build/html/objects.inv | Bin 951 -> 1010 bytes docs/build/html/searchindex.js | 2 +- docs/contributing/contributing_function.rst | 15 +++++++ docs/contributing/contributing_test.rst | 40 +++++++++-------- docs/contributing/installation.rst | 0 15 files changed, 113 insertions(+), 65 deletions(-) delete mode 100644 docs/contributing/installation.rst diff --git a/docs/build/doctrees/contributing/contributing_function.doctree b/docs/build/doctrees/contributing/contributing_function.doctree index e070f7a7c0fe06252014ccea950b4ba52f6369bd..8cd048761a4ea5e5c184e73ecaf19350cf445e42 100644 GIT binary patch delta 2690 zcmcImTWk|Y6wPe1&dYfLjx8r~Cd473i4#bmg0z&-mQZ67@oEtY0UUeM@#5^dwzn-5 zWQs(=>IzZrqJFjF^#LtEktL+G6(v%uN^L*-_^E`11nMIyDu}8-73yPV{D`qalb`xy zc0F^?nRD;nxp)2up3~){^4YWflk#sCxLR2Q5t}vG?p0%Pe>jZel;DUzaKQgE!66j~ z$*Ux+MJ9+E#}itRn6z}%q;_M$_Q%aP%_C+9ZKTKHcG(k&E$r`YB->&@n~pFj}z=y58{}nM+1b-1__So0gC-NPGa#cd{EP|N=OjLHKuef z^%aHcyD=QAZ-Z#HEm0APY6=O&@wgTal4yT_*0T@(ZwZV)sKJSP%yl#t>M&;m1}tE` z@?st^aFj27%2?#akx(S(tcT$4tm?Uz(o76~F$Onq1DvibOPtSy-Jbmn`WT^2`~x+Q znnrsjjvkf;o=g^aLaHY(jvkQ(e%iv)pfwLNZ{qlA+o%Z}Z4Oiidu=X@(>oCf6F6$E zugc`q>*?WRGe|S;2T^C7?&(z)=DWV zD#`<_Nexx~h-AgVrlGHfA@CX3h7$32vgYZ`!u^^FNm-qyvcmD&0jtu-c^cEWuWHq0 z${?H2sfVsLDxzeZM2Q+8LDPpaM$CP?F$9~dhpe-iqBtPp^1v-iS#5uwHW8`^b>B+z zK1Q00R#i4y>$xo?8f;K*+lkgNZ%5JVg^uc6;Ouerrv9=mLg+21wZDK)XN;{(uyQKx z$y;#BzKgAA1^L(}Sq?4;IvsDwm*>G=W6-0IaziHmLtwD z(02ta@{3|A(GWsjo`O)?*pBYz8Hq1D^QgnSA=3B>Oyd1uG_}FnmRgu@dIr_Qq}v59 zS1bAlo@Jq5+tLH?yQ-Hwd=xyQk12n{4c94_OOx*H(h3PKHt*n%S6rUmN{>`je z0Jew27*nn+_8!*N040F~hw(z{G*mYaply7|=ZDx9nPX!&mM;j+3T<~@ZVd^suE&ZU z6+S+PRip|Z6$vaYeG+>xA0H3fD`4-m+2OsG{pf8DMJHg}(sj~_d64@A^5)V*=(0dv zf-9{9(xrJ&`vvMr_aXGTKutqQ+kiAZ56YiW`5L+-P`6;uvUSp}c~D~l_4BfEmL1%$ zhj6aFOL{0!&c_Ba0M{+e4&_gtLXAp68jir0j?HK{yxVbA>MBlcT)tkae5tso$fzdK zs1}87or_Z!I&T*zy4WNgR65y1>EQ3zXo}vYGfD~LRS+Mde9-u?l@CLF_=yj9_|VFc zm<_s7uKFiP{9uH{cneoJ^+~~;q}P)4Zc=b21z%Edom94RqNE^6>a>|RmO<)GEAcWV z$LI{55;Ew$v<6;D(;7DAH1L8UG$=DE_limcgDYEib>!U>oI6ADFu}UYT6Z|45_SjB zaExlvc&;P%R(=@dUi%QLn(@U;WmsCU%K@B9W zXAua&qEAwR_F@zm=BL6w6-4#1=t4w_(TAeK&N*4As9&CQ&inj-&*fa+Som9;>a6PO zp>;#5FA0h+c>>@Z9$TJ|qtXi1YAVqx+?!}r>eL8PDL!qiFosEfL3fiI1V zXbFu+drBMJWUxyeI3c$ zx6+KBT31pNo=wx@r_^HnwK5a;*$uoWwS!3>@bZ}KveLii86g_LNsl3Yeq)7Pi8pmY z$QQ+1vntqZD%+{8p^|KYxVTwemMH^SsQ@K7qTdFUOyx+Fy<8&6C0Hu$CMAGicJLBX z%4gxc3VbP@BL0Po@Nz9)So;+y3tE&?IiDRh6p`Z#vzrBL%YF>!Ijh<#)-hc=dUKkf zOf;qBSm65qruyeL7~tbuHILjb$QpA9U*$Gqmc@#CliMIK zCa)9nUQ0LR-~n3$Na(kggLK90UNl3!Kq~Sx@Tc`4lncy*cWqwqEQRfu!A^o-AiGd) z_rk8FkcOG!GH}S=4BZ0j#DJq5I+wy41vcpjLR27qIN)?ZA47DDZ9@|d=4EHfxBlL~ zc}H4{J6+Y_!k!X2Ly*p_cYQ*NLNn&gki=RpyZ{ia-&1FCt<@1b} SxH!C_k+7(=0O~PVTKWeuOn!|3 diff --git a/docs/build/doctrees/contributing/contributing_test.doctree b/docs/build/doctrees/contributing/contributing_test.doctree index 9bb2c0a29e3fe98273c2f3ab61a148b7e126c42c..a90c39a19029b415a6f8e929fba79dd40d0cfef3 100644 GIT binary patch delta 2816 zcmcImOK%fb6y}Z-k~omq#<8hmCpQU>6Oyq>Pz1Q7r9{f3p%l>+kRThy{&$#md zMFmk%D+nD`f-{xqiwfAaT@+bRMXf4T>MDJpzBW}iU9_7Ip&B)cm2UK@{8^Ps%AFK4mRUnWSdY zB!1iCZuMStEHWmkS|XFd8WC_Vk(^DO5^!3=DdDt`k#ku=(r}i>uzlBS58;{@ri_m! zWSo>GO-WDdnt&7199CsrNeXl|C16!g5}d#q1>B40WF1R_kiwcw0jvhfxe^ro;*P-8 z+NSf)oFa=tQo}QHCM78GxDEHi#|t2eY5bH7zqv8Pft+x!J_3U^E%0VjEjTts;)Z7% z&ZTpuig*D>ZE&l-dfmKWo-;|1+=ly}ZFM(El*Gu6aUZlbHXV-?`@&PQ_##<+TH-7E z!dqk|NE>CkW70Him;d4yuC}+p8;z~|eTQ{PN=v6K2gVF#DXo?Gf7I&&?k)=abLgvy z4lj`1#8Ctv(5J~{H><0QR3B?V8#X*IQ3)`@N#Zn>TQ-*wn9?ZubWyPcVZ8=-U0??j zgdnN9A~-dY&?-#QDn27CvkYxgRun3L%v=;hb8Uok?u9R$?Y&P;owPVobP1=a$a*n* zVp^w4$;f94uGwrtN;%Bp5olji<~S;P_>JfOPxUdh2;bNDj|8c^ z#UD+2tCX~X3VF^F1iPrVh*vI`1pI&r_^2)5wsK5?gqRXqsXBd>4JI~A&@3!p5L;Ql zw#5oLGP$Av7>y@5(GQ6x-g|%qMK6_Bh3>-nu*-u`7!U;8%AawQ>b`_Sw236_Hp6;E?APGy>mvA}+g{?M0JoTb9v_H2r|9ccoLmcK{_H za*7pA;63kG=w;?r+h;Gm+cZNF7>zA}eGzn}RMDk}D;j`#UmqHU&wSm5F%QeWBj^?_ ztsC|QyU`7J+uuj8U;6`HYt8<$@Wi{+xdlG1Yv;rpaC|FIykSgEK!2ZtjfK9WamE?1D-iEy zh~XdXhx(ASmVNb1V-|?NY!K0?=4-7 zn^+xJ5T{kF7gLK;hQf%g%u~mKI}m+jVR0+b2hD!?vUQ5vUP^*GLC1q!=i1&+7GchC zBW2GaSZM3zhAht~9@WsjFxA|;RlLqx78F;Aa~BBh&!PeNr2RV5@?#zQICLX_CH%m# zQ)8tMiz>Z|Ire;y!g(plVLJeh&)E} zoZ!|Q*B;=a*8$&pIyc>KltHXW$W$A_}frGK;kxJq7#S&S=XL%ZfWmbdhc~i zFboXI7Mh6ps?qR3c=ACpkR~KPm^kADLc*IbYGQoiLE{nC2T^HUO^^&xjlw`(3~gBxO=w9H9jVwD z$rBcA5M*H#bOvUZs0hN7OvlbV^uW2Txg6iqGTpS%m( zSG?jm9!1NR?IUAamT)XiXqk*+z~0rq4F;oJ%qQbv4JS2hP(|;N8k1GuQO944#yTVZsK1=t7OP3zqh%u$wzo+U1IBY=)Vvp7O260 z8Jt#B^DGX9@Jo{hW$?cJ@(y`xPwDv3HhHtWnf*(fr%z9YdgVx;9I5f*|^FJu~+Vm z{F5uCoIe(|3x;0%xc@e6k4No)9=2llVU_y5J{qSjyb%Rhj{@h)Rq&U~_UgA(reWGU z=w&9C=niTzN6EZdZY|FfYf~ZKrb6>=Do)!NNBhbAyusqW1Fx@Yg#-2gTwAqUqQ9~$ z7IM)?oV|2fTfx7&5g`kN8(u(8c(*wSy@5KLgIx*gPg&q*!!fqm;0wX6+zd}Q0kToRM zZmbKt2|?_STJXH$ie#F_K>U_7Iw zm3UTpQw)u)PSRs|LNTbA0lJYj6NbqKiZ)hUV98DpHd>MdT&*#5n>%v!X6Zc9Sa&@G zr@YXyQ#YAA;lrOW>Or3QB|dFg>Ql#pPyLzkv>3-ivPvfAr>M~UfNS1%uTrxgSI1Op zy2mxORMWJTYl5qOZ+pL*NSjH5<7~txSP=O*FAc8pO%YOl;!^fJtd!D$p8{N|=^@wj zS~X4Emc}Xaq&UTkt&q)w;%!|TGsz~wkf#eYZ*YH|R4j9m?5>Ky)gq}BTqnT~>*T>| zinrHLJj~x?_{&K-irCayY+=H8Na|RS*tS?=6_g<2T?~uYl}d?iLSofK?F-&=;HQw!)5aJ{uhIw8>Os)Z&BNBn`N)Em5B9_u%KFc=s> z5qLlF0m>D^c&~)+6vo&8X$j_dI1Z++u&>lK|2;>4ruXUH)F>lLo#KzT`Q8-V=yV_8 z*3-gxhR)5<`_sZ~MwrZ)G{EP?LE2wr>Ss)s=w14yprMaaQ=EttR&I14N3PLeV_fHN i8DQ%Q!~RXf?Dc9Y7=Wv;Ud2t2^CN$vL`nkTl^_yC0#Ou_h{O`X1c- zIrrY~>7JRrGh=0cbWhhgr%s)!I#qS*Jod?5A3PFY!T;3WsOfsag=r@^=Y@@+?gVj5 zjoq1ewd&nD&~vTp-`l#_np8XNX0tV?hN_K996C+LgH1Oskkv!X#{cTm6O;D7U*}Q=>$_zBMB?c3~)v>W$K##B=k{B z^+jQYdzszDUVs*a%zFzhHKG|{e)pY}f^@`#jdM;Ig8T>!P`e^0PM8DEh1dxquMtG8 zGc9%0@bN-CZ6|Rfaw;*(YIfPFwQSYj3>!W`E!AK1qWHY`cuNgd8qKB9TW|rr;pW%f z{Q4V9bKYX3=EQdC?&;Dg&CMH2r=7AL#hx9M?sP(s+=mX_1{i?h(on}(DDp6$3do{2Vy^eB|HqZ!z{9L6G(GM$1=I6Z&Ej3(e z)M~wVbuwp>Rle#3#mQSQah)^h}1ZAqBu+{af0F)@@hqDBuMIzyEWek>vqg4 z-LGW@9-J1erRzxXPz?X=&0rei;?9)$69K~kKX@YU_WQq5>}~6cfviWc3=Xw=ALf3N8F?CN&KP4waQpI zHMs&~BdlEWkbBsD8`bQGf|4S(+*91tJ?361ICjO2s=Z|3YLI_g^YyqjClv;2cCe7x z3mDXP2MD<5VT{JEITofJ3#ngzM=e{*4+&>1)0V{<*rXK`PlSy|d~x~-Q+DwQ@cp7j zTv~9TO&4OzuGJdnt@-5f$Cs=)w1Wt`$TMkK_3Jt`L^V{0;ya-Qa{%S_f~s>tqZ*)o z816pCRJqgc%|hNDtu9Ug*+3eYX-Pakb^BE0El6wkYWEtcySwVl+et09Ld-kEltXs4 z3gQBu!BFH7M$vU5Nb4DCHAWTcjcNiW(YVusD`DH}(5*%sG-AgJoq1?xP;soNX;+-q zvhFl;F?yNAkpYf2mlnwSMwl;4Obg3)uL}cFBO{Tr8v@rcX$a_xUBa4pHw9eaM08XXEj7LeciP;lnC1-SJ6BsuO0(x1mHv$XwXjY<} z2_C}Kvz(?^Yb+RkG6>q71MOu-k(I|3wdQL!`qs=HZGwk(xCG(WZ4VP>dlMSWin%+0 z#{q-bWwqw!NJYj3mb1neQG$ZqbvtN6vm+}BF<}J5K;Xqqud=w*TINcl`nTmR1Px5~ zGtzc{I~amofadAKJ~1IiaQn1Hffd1DR@G_3pw4dN{@h#L+oa)Zero zXSj0~Of)u0lR9i#V73|F48^s`!ff~Emkel_Kow|L7)NH5Lkaw`g|Wk#8*CAH8lO#| zmMN$A=3ti1+79z{_AW=Wdw;%MI|OoqlWNdRZ?+HHeH+$&fIT-X5%`2S0o;eNVyo*U z!h;dE|L|oF8w>ZK$cdrGgq^x$Ku0D!2`*NEYlz=*Kkt5?q`NnRSvjTWvLPw+VoW3V zpwu5`n0A~nv0PCIGGl4Erv)s23cbTsyH40L)wTahy*BJGquIl_5g`PzH}9c=>Q92j zpm81sl`BZ+QH4FH`%eNK;8uu>T7a;63*8lpH(J-{K^#39kfttlQZK4CjPW%aG@rD4 zHR!Ipf;zmX5?+!sKloJ?1kDj1u)d-#m96p!tAEv;<^u@F@8orts4JLbURyq^QNWtD*K~D3;_(>US zo;s={y%GmqB^bMe3_N=}Z7j#QK1LtLR=n<35{I?9i9tpL1KYraXHs@EWZpiIiOu{m_lk1B`g85#C3x_3wg2|)7-#zbhrG;3b0HE&t!O96#smV_CY72HCiJyv8X zpqS4TPVjg$cpA#?oQ@He3I-WCkwS~2$g#tUOQBniAeytLt(LP8M4fdM2s$Pxiy$?z zhlCyqL!=+Ht&`I=1gDCL3gT^bOHnJDUr?1)o-+7G5;qe#|1|E}#c`J&p3EBr4G4u0 z%pg)GN5q2@Z4n1b{?P>b+owyqvF0xGBnyNz3-m~(uyaaEw`Pr4$jg zfnpRb4b%2!1c=?>w{*hIqCl$#l;R9|_%Q>g)dyJ-Q?T0GIJE$A)pkhNS%YGPL1rGS(4Bi`|v%F+;?AT?!^6fm)?B${U`3d?~W69-SyDj zr%%7NB|RU=n#xiN3u(I!i*?_Lxl@mvIE8li-FHXLn{I>)rp<0zdtbmzSs+)Z2AWlb zz<@~fxkpNk!{C6*eM}8&e=TIK*zSpr`dw``sPL(-G@4Tg*f z1X&)aEt_Q>^&XW1GEeeX9m^*8mReE|bTF;yrYaX;)J=?iSn9`(X3aV0)L?Nq)TEV} zgz)>NLZ>@mdNj^lfUrG)k0S-yC(XEs+zUcz1RY#7Dn&?p@RAC4iop{C&bcKM1aa}O z6icA#|N6EouE_Tzp+Gj9xJKkJ60SB7EFN&(DL%< z#<@DYfQHpVV#5o;&$NTl3=ajnX3cUq1BcF8BpzbRb!^zBwBdNZ27)IzJF^DmRqjid?TbhUu$+(XA?W9AiRO8=Ym67FS;P(gWCS?tF>Mp%c_N#7cjDQIAYWL zsXM~Y@gjjy4nn7OcmY#}d6H$=M%p4Un(RmI*=H_$-6>Vd#1VXRIm z7t59!^QAOhIC8%iRh$~uC}4b)PTakwla&*7%oMHAepAqOqNQYK98m)%lOf7`z#s@P zIAkfk8fI6b*>cDfR>B7I25IWUNS^S=hN%^of<@JT!&|0)<(k(%rj76jR|%Z+#1Rzl zOadep#6a)kGKvb*Fd<#X5?zd1FR$Ce2U%HNK;jaKia1W!&3h`ASGADc6VgY#I>%)tCqE9 zat+8zVud^+*-;BN0xNiAEn+vs#I!i&22ac6k5+WX3`4Na-C|Z&hbo+&v5 zgoWC6Q&w#>t0v2?6hW?^#WGY8$wS%=FcxY`67y;Gu?!Kaa{?Z9o0*8^YCdau5&Rg`|J)I)S(I^RGBv8`AJy{QWVY}NH z9J5lq(q=quV+yiXrK}@F$h-iBUBEsGR=P1JKH`v+6JyXT(bFvPMHyTMvWkwA zFKMr$hBUX}L}^5&P$52xPHO!dPnDk4QB$tOu!CP`V1$P$9LkT4x*x52*f zqC!K&8iPTq51}QJ=h&Lew%SH@&LDNB{SWG0xO8*R>@K>4w11!mz-~$CKZ{k-1o{&9 z0FOUY#y&*_d!-BMPK3IutwR0>4Hy34a2__(Olmb)7!JQ$t2L&iI8vNm0OtVLPm7-! zR_Ky?WAdoHLrvH0facT1BBEw_`9qQR8VWt zaFhA`%@jN4dF3*thAxzY+4b!L>v?YDqc{Pd#Z1k-Qw9QIPBa09v<#y<} z39%!mHZQ4{Wu#b~8%L?2;sE0Mk#VGKsR6JvepZYajp4FMs@_N*&s;G@4V-b z>OLE#{69Y4>^g;|^t%f$uVz=I()WJhugrd_27LPYt_DR)zklen{^N*<_}6o9`s(ld z7t&vEe*T+@!agY_1d!UJg`qp6hV>RCas;&NF1tU_dKkSOWEY-meW3MFYtsKP@Q^L# zL@n|KGurS>H_4EuQ0O>qKr-}_|Hrz~5jOK^#Hk?)7?U_|1X62FWU$0~`Yl&<B-kZ!Uyur+QGK$j-SYn#ZKATRhH@(*()Ar4FK)1aq4Wg^!OYqv zt`UC?U^^)LL18>6U(SF%{jrVko}&h#JSqEsgiidg;6ujXe+_@Sr~I$u3uJ!-U+UUh zKyA+5mf}VU(MQLwiBRu<3oZPg-~*KV|Auc+?0*~I!1nL*^)PaJPK! z3o#qHKO9NOC{M~xVZoC1SVOQgw@sHGOd^Wrh;gU9*iFhT;s;>n2x_CeRx3TEqqRH- zUR#g@M)5wnHhtHPgMIYgY6&9|O>K5Cy0SGURg_6<_?v9+n%dv7ivEuEqxeQhM% zy+IPl1Fa#rt8VQu6LtytqLMkR(?-ri?c@|TX<{{A1aYt$-U*`glf4kyO}9r|p=Gd#UCSt853`y-6vOj0hI@Ion}PvZ_9Gze z106}|wZxGRN!Ep3p?gZCr*fo9m+vDE7jR;#3y%cjdx~PrNlGxCFNIgI;12W(y4 z{}Vk5CjIyJDDj`_RZuXL_!RJMhTtjAK_taH9&Lj6KZG8HtDnSQMI`S3PKx4VjKc55 z(Mi7-ON(;!@JZUSVrPkvj1BukjnSp{S1cg&=6llYkarjFc z=kNAbmvyFeMq#QdtAZlL+Eyc_T)fO6rHRt5VL<6VwMRb zR;>VvjEavG)fu9~ED3v=)t*ziu%jxlyga>0N=A#{wLH~>Mb#pk#P>6bSI|>UnB_X< z4tgxn!>!_>I(S@Xx7ax5x?eGC8yn|sttg6YzIY;@%?=kP){!Uq;1&u&Cll8c!fzJk zV5Z>D7Ddr1gaURiGo3Qc3ZTfScze--Xw%6n%vZv6UQQ0|A6Uu!eX#DirH4O3J|~}i z?3(EMGB>{bM3;XJp+Am~IsaPze{?u%ikmm9AV=tGFpq*(=&h^+Uc?x;MUU_;dTWfQ6jXIpNp*ri?aiw~z z?Dam?a@20UZD39uPWsz+K~Hwj$1eKlr;kDU7{-T#%>%O^j-AQ=iY@mXkSkrNHOkmi z>vO#-He~SEh(?_P2IL?Vw#jCpE0QI`T~wT4Q$yH3$e1gBDU&0sttxNgOV~t2-UdtNY zjJ`IwLYZL{J+0B^XFQIjy90r(4Bnwf8vR=$vZI^J6jG^NLyhlcJ2vc>hCTTrYL@ ze~NH0w`$CG6N{{BSfAQgHQkOL(K@2rNu}-!h$DSiEF8nfE4f(k4}ov8PIzQ9*9o0V zgK=3J3}bkOg2&8oil8@SIMhh*GMk|~X9Ef3`sWqu~V za#0kS{H&rVwEXy3&}GZ7@UG0|95H&XLzrtHqj&|E(XY`b#(1k57fcp$O}FF)xb29Gz>Owd&ZR{}`~LMOwu-505>}6|RPc&g z(=+7-Q#pEQJ>i&TM8^G(Zk+ocE{fvuRDgdV0^Dqyb>v>Uq)5`B)!hdA2gRZq+xd?ikce1yP?Oo10WvqU8Q9fm?epgWx zovhB*B(Y8nOFIy&+ zgU3VZp4U0l{giaC9e-v`zgm=o*%WxOD2go?!aB}M|9s12u*O;GOa%W^lz*8BepVF4 zmW!ZA>~J+6dCey_-wA)T`t_&oQS%BbuU3s6u0ppPjFgWSMbXLX0**h69mMSvK#@^# zsi@9K?2zC-XQM(78skd7oYgWn#Adhg9kkh_@U{_O#g^M?baD*m#nw1i#r;#YZ1*Hl zV|*$LPq*N019>};215t5aCe>Qzr-iCvR`y$EBi%fx3XV!h%5U=r@69U)GPfWE?nZx zoAg(rM(Ai4sL=oS0dA0wo0D8^Q2g%;^fWf#EC-=#TZNyR80I(8qosNoPfz*3iXK$o zY58TYk8>&!&p$*S9ybmaPL%Q3F!r3x?>mu|JCEPH_yr#PfouM_0FF1<=v5@Vt%A$| zUu@Dx8`T~!ddSJwSyqEq?oPTIv1~jZb27W7PVbG#JFO%&|02mBmkbBxkPST@KqKnc zKl4=vD&}Dk5{@)PI}K#T7%{)-jS7M!Y6l*qB9wj&GuM9~y7TM!tDPbKS%BvJkUsHJ z7d=1pK==UtHxHxc-Sh{+g*v@2v)e#Ugm~g(&X2ii!k=>9^Bn$O_Rr%JHf@Q&Flv2! zJ~w9lpnYyM=?)>m=(Z&g(4{hb(TRP0iIVeN!Y|Sye9>IO7tJMnkx|4={6uZXW1xiS z36OwU(~rz1UaW6p`%ZpBC0A+0wId6co>}73oak6)GM1T&WhP>oX;@|wmYITOCSaNS zUrtiV((~j*6`c+{69|7!za`-gAgj;$L$@Z@FzL3M%Mr0?+YTtwW9$Tr6NQ`nY zdkjf#yXF8r9-crex`A6+@gjvF7&iqtVWpp{=#6MBf2b5D2@kdL)ytLeb-pVB;^+a2 zJX$*LN5Q+vg^CH3ey+|}q$7E#IMrTp{T&}RR~xxIQlIp4rSz6o;BML~s8w!eVod$| zI*M42?5A4i%_E?oni>o5QtP`FOl$6f3mXP?jk*3po60?IVO&Pv6Q*O5!-~#KDRU)P zs(Rf4!e}N|CEt{;#CWp%!ymv{qPIdzc20HVEsori8hoPtDyj$F&NQbHkml&u9q=3& z&enB%)WcLjUkCJgP;i$HA(}IYY>0ams>?nmjE<;{?u({@95`k1>tm1@Fi`-Z$YW+g z!j0*9RdYy{PZ#t!I$4OaV<}l}=W_LtSRupIVKGV^kvlf4RzKQHO0w!8O=;&zP&M&D z_oqXE@t7Q0>~U^VQ!RCR9BWjoAH75$$Iq{LGUPQY9t>e`t*+5kbNV+Gb=t3W9==1* z<9vLCUackNM(6}{%qLEypzR=+>T;|MC~y{P#X%UsVM_AnR8+TfGlC_1Fs~&4X$D6o z?aw^Pe@2E*yF6zCEC;fjKU+D`APKATg*o*?qwd=jK!?Bm>eE=<;jIn*f9%Opg~ETm26(FF{|){60!PaDMIp0}oAK*K`t=o4_BHy& zuiJbbf1&srDd1lP@J#|xkm-L*0N+jl-x0ufQ^5BG@B;$yD`P(tz)w=ZO9FT~1^lM~ z{woFiw*dZ^02Dy@KNrBZLHx}(jke=2P`WDx^a)@v1q=ybBn6BLU_1rv6~F-kkjeHZ z1aLS791*~kDc~vrTulHzS$B;9t|I`yj`V5)T%Q7N5Wo}x_%PSB0B%YFHw)la0x*u- z1n`Em#v29jmK5+-0h~wycM9Nc0x*ty1aNN(c)I}ZPXTibFiTZDwTE|*Ns+L2?$iH? zks8*|6Y;abYV02T4=j`cc_i@8-X(7z;*jv9|L5QyWpYT~m(;M1T=}I!2Er$QxP(kfwI=ro{R;r7k-PAJPSKm9L}etm rGS%J&{*OsKJYLiP#R)x8glxbdr7LQ=!Xm(Vk(^pZL;pgjG5wp6>~ literal 27975 zcmc&-du%0FdEfP}-|Oe@de_-axXI?>gxH1zD1tzDvzu&?6DMSo(nprb+NO!JKy=vcfQwo?7O=^d{2EJ|5M{p)AfSOGfuGVg^i%@1aV7^ z-kW%}>U}xThg!Ek)4I}{QU~m2vo)^YDx}^ifOo zL}7({ncKx)fEI)-c#ADHq#0nod(KKhI^zDuvJ-|NKLP_(cjUwgbHKSAJ3-_%f~a+| zrA`<=UXEw%ByL1bB}Q4zE<3fBt$Leb!w0CPdTU-3uXsTn)WN7tlNIdd*$0 zyR$U!Ej4ORY?tnvDV^8cyt8z{Dce!(*+J=ECj`ko=)i4&@i%X;esAd196NGA{cC1k zGxOS(8jhWMvu4LmWHs&Br2!0BDGc7<2he;()P#j~vT9FzGk~-$yT4;oIJ7$sY z)pG?NToA0KTS)Lw4Gl44_j`*o4C;>Uat)Ba$LKeM1}Y5*cDdH5ETR2_m|F-ol_cs2 z52Wd!qnZ~iMV1E{YpDbO^0UtX`?6h2Sfr-h3HO*ffCbo^f41db=bmuS;tw^ZMaIgB z$v%vYuyW1g?xgzw)$E0Uk|4I+^W4-u>0U25y5mOGUNvyl&!5&pJ#NiQg}#~{EGG6M z2G!*N0rxzJ(bzS|!m{H@>Xq-PWlQ;S;f!V4@^l6^NyWs|VWSaWnR(ijU3nUOzoHSB z79B{_<=C=owZ@9IkUaI&suhQJ5J47sC9SDmU5AFK2I>%eC$yjrAiQ2sbuMdEebf)b z-6xqUcgDR-$Q#k(;slr*%m!9k5-&`@aXRuArL}vbdy~{XRCN~Yq!wEt)}3L>al2Xt zaRIMj2yzIe=sFQ*>p5vPN)_sjY62$FxYL5`q1)<^twtO)V#f-d1xRL4ajd9mSDe*Pt=M4zPNl?*MM<-X)e~hU7jY!624ej2?mK&M~e1e|RW#k@{ z`hyJ9h7&55D+)noEG_qffW=OscbIC|30tPRwqL2$hW=$VBa9m!LJ)fk9vZ0LBv=X> zD^RFhK{}5rY&qRO7hoT^f?w1EgvDFvu8_acx;+nK@5z8Pb)l15Q7vJNui2pWq|GZA zxKr-!(xdRqSoXF`N>~v$Dq4OI2vVV(z;Jr>0!^z%uuS0aa=w440t?F*%g#vn5vHqd zYq+)IRcV3jlU6bsR)|=pWOls())Hu$b5aa(wnX_qC*V=W374!AdaUt?hulC)U}(k5 zgqLJW#<YK*>HDN55;Pq#JAQGEXu`NV7nXR0`KGN$J*%vH~Lym2jRdkDe9sb*rMZ zKvp(sGE_2GmYC7L<wwpcX4Q zE3xZCM{+o(-t5M4GkVkPY^55^_)*oVdCTEU;KZ{*vp%cqp1yn5iC#a8iI}d}Ytt1X z43#y<*x?|I>lrd^y3&f4taaBDQ}DB%xV_~F`Dx>-7a>kuWs~0Z#7|MBi>6YF2+}}4 zik=PA_AWSxo5Am14>v)977Yl+MY8at22RljX%SO!$P^@GJlCZ5xB*h|ZLyX>eKxDt zrA3)KitP|ka#f_xF;k~Tdd`F-6k|``|M-IsmgdhqbYJP7`yM*;wg*q2Id|^S`z~B~ zYfE}Qnl+VB3W2m;hsJvF%>4Ps&zwiQ2Om6L^JW_1qG@x8V(-gXDT`$4R9~|S7Z?!n zK1Za~7z}o(+$YtbwkI=GF_%Y}%4GqbIQ{gMYh@1Ll_jusam(fvFd#jN-C)S5K#=8u z*s@yIUhfGhAoV1F)e$zqw$ze(pq*(=H&wX|rEYxeNvR(?iEG{YLnQs9`2pB01L)ux>BG%!-&&76gAaU>l{z z;RupjbHsugzsH}1w21B;!}9ckg$5-j*x@tlH>C?P$qE1O&_KQF;lL?jtWGKC%a$4o zr8HeQ^pF=-oEl;jFg{8b?zrh><3b%ZMH{5w6l}WCQnE9Ss6La)5aB&)5Cj+;vXov8 zt1HoLIc^FoVFP)CH1%O-p76(psTG%;Mb&%9Tc+Q2)2pAx!8qkEVYD|Z z8?9L4AulSx@0koGJ4fvyd!pVcf>8Gg(r(xc|r3=~}^d8BItIjedddSmI-Po1Da!acn&#LL}Ou|C#e{EK6 zIIAXMSBfCl&r%tph~y#d1{e)BEs6QG`e=p-)j5HcmgP`|PMz|M?d8X^wvwnbDtIkL zF_~4VdjTAlux{1hjlf`JtjTdMg7Fr4cQ2$!ax_YU7zvcLa3t$N2eyZdGJXJ)ma*(a zR*{@)5)Ld(N~K_}X2j$sAgv~8!;2ZNi3}Hy9HE5x(<8G<6wa2tVAl1p^;FB6 zl{RB(8&iDFUzqRS)%`crFPOYI?>XREPB1I(0CrMc*Nm&g^2*F!OSdMf1pAQUt&7@X?)?=5j^?Xux=P19cH}_`5Q;23Nt+_6BT(dO=y4X9ywn$9# za%_E}rxRT$GkeTwLu?_>^`t2s0~X$({^UAbzP)TqrjN)tysnhOS%M#32NzS)nme$e zf7%>GgY{%Zah1S5f~Ph2Mr`3}EsvR`s8zCAtu-~?21iB%TL;*>(j$Shulm3jN;Hyx zJ*9>@DuutHH%n9(jF1}QL@5lYE!$KFY3(BLb+AbQKZmw~kbee$*VNGpYAsm~c0_6x zydc_}fzR@sI@HAW4dp1<2q+|WByj+6G$Smaz;hN`tyDATmd&d};X)04KLX?!-p<~9+j-1+p zUFT4F7O`i^6PEk|*aLa2snduX=kEvxj`I zdqExI2A0_fNmL)!FexXVC_jN)aQ@79KKK2rmlkjHSJSWXvse9<^eg)2t^VcoE4luk z{4o7m?s~$1D*O8SxBWQ%TKUWq{?qB#<<&3vQTnyI?_>UQ_T{W33Y(J@g(IIv(U?1{ z2KBxl0(08xmMs@Z8J7A1T8AHMy|?vfYl^8Mea6{Q1nEYV%`{0PrBKKe?fNnFc_xe+ zUB|i=jW{1eURn~zjX-LFUtYi`1F9|m*FdiS>-a&vsv+dK$aA%8EB0#C`XI=wBS;`& z(p5i$s_LL7p4;@WEM%-_sUZU$%>?8OK=*PD+Six!C;g$lq7$#s`h8HcH7tez-n;)* zM*kQLG4bZeT{ES#Ac*(l?UHC@@Q2W-9@*4w`7fbORJPSXE)bvvd%$Dg9{xK;?;r$c z6}rVx;IBUHhGZY)#d7Z9A~yYdV;kNrjHdrJpiasxL;j2STL$2N9e=v#{cqqGX#N&{ zshjTxsX5D2iW?NMPw*S$`hSYw!1ibI>o4TjU&^n);$MmX z*Z6ISB2nIgs2g6tjwri?$gE_x#Wg2|oPPkiosdIoX$x{DUblf9HiCJs{QC~cphdg| z8MnN4rgXpf1tmMEmd?r&;_1Q`L?iMzQ;?^s>%h*KL&~HhRZ}8C#~wn)qGac!s1cA9 zwawB96C%rGM3iu<#M1@F@~Qft)b8h#tu{$bQyBRH9xpn;2{eSc<-=b%Q%2?w=MqGu zh}fj;6qayOx*fSDOdGf-z&fK{x3{+OX{P9S^ol19zeU%xZwOZ*>?V08I{pKCgM>b~*`fhoLQ-k_;?Fw@YnFO;?-k`=rnkOZ6vduTK|iksvRG|w?>o3h zN<H>Z)nFz6UqSXqZ$f)>eQJK+(isQ*nYPF+QEo`V> zPHcL5m!yk^xRr@|OHp~qR_~h_#Vcu|&gpGxvQn#v#WoM|t-WF+Ocb(jyirb8iYS;) zlMEXc?Groa@J|#)ku8@WlS$fj6ZII<`q!R@_w3m;Oq`;8$~LCpXNvMK6Y`%fiem4l zU~4boQ+qfC+w>AXQIvn#6nv~Giano#4qn2y_KfY<^b)>NlusF}Un+`XJ*x|t_{>WX z!%_f6M#Ya59fCtzc8lf^wh_4AyN6S-O_TJaMfsNr_dP{X?D-UQFiFmy zvHhARsa%v#8LO?LDAu#OfIZ1fl4!F6C^9Pkv#3thCW*KFUOAIgVEgceT@o@H=~fo% zqeaCcldNB66tAF#nlRh3v}4|33-&8}#Y1)M6b`pgf|s*;x$ZYau3y?YZ@*X+MYdkP zAk(wkk?X`Z_QAiqhm)XBvTQjCe_ND;nSg(%D2nxyP(bfxs#BI(0TdY(t)c_bs*}$p zyb`MO<(zRi)D|+@6_#9VJWiM{YJf$Z!KUE^w-b4l?++;>Wyy8~@}zNTTKC z9bwpfzmpifmF7OeeH9=*6YMcY(NS~zO^gi3o8)1hPCLfiKaiB2!Q%1t;`AZtv;zYO$zXr0POhdN^IWVH+LqwMGy(zD>;ZtVTjn72}IKUZ|N zGWGThqv)vKc7N~xWO~30j;ZYTW@o+HHb6hUSDaMWpK8h}v)raLy}Gu@2hLg>oYYV5 zoX;OGiX!t&UXZEkB<@8MDHGc`Tleifn~Gzn=v4=b6zplbbTMr%U2K?yZx-cXChUJ$ z6vduT!bzM|r7bQT(QLLYk0!A;ho1y~?pvb6rSJ8oJ3&)2~J6X8hSHcAjvfkXgJ9dpmx|LnK5q%Z% zg)+&yp(u)MPERn3j*08S?!}lqlZfl=bi0AC=jBhm-M?3iR^zAmQK0F@0>3xPJ#Sdm zXNxi}~0|iCY#;++dLwvVFZ4FAOBC$ z$K$&heeeasT);6Q0msFn6P+nendluU&Mg*MQKtrH;`x~tzC6HE-)==efWhyEm%c%p zsl%thZ+anS8W&-vb=MnK+53tzKU-zb6-BXL!xfl6ZMFDvLdRvk+m7m1_Z+^wOLI!2 z+R8%xUQy;}^Y=SNQDpP?xuPg!{t`8UycNB^iL0ZMW};hjblG!mKcBLnJIEJ1=DPV- z2fk>#WbOdp=Rg&T_UGg#2g+zIpp4izw?9$Cggf^t3GNp%2ybFZR)#K^4fysu3@G)XCRbQ~g%%BB>g(Y&>{yHoIDimk4_0Z9$qf zcWw^XcKRixr)#$~oL>EzmiJZ64R{n&6SU9}mWLtpMK`GllBffCJB5(>{{@Eo?*=dY zAKx3!h3auuNPfok@Vt%0v=V)xO|Xr_vdO1xprjXQXJ2& zv?W^Bn3Of9WQ_?~V>;HDj5VfWjfq%e8rGPEwS?!=eSg-0Kf{#B93P;U0 zYO4{vw3d4y+d+x{ECx$&WCu=&cidDr%s*ZiigB&kKaVzC?ms|(y$wH}ZC!1Z@pecb zUHsshpn8?#UH*bcdLODyt!t|eJ;d`+>WuyEIqW_9txEqL0Cqw-c!A$%EIopk+BT*4 z$8#9li1gpdXw~6I_;H|88*La|fA-pj+zrbCI$Q%sE4r^%*>FEx5R91u`w z^N(!sLjo*|Y9oA`7rj9o-3ZU4rNrUJ8{yK=jrod{+@p&==18@Eon(7A%+c|rxh}-r zk<_FYmZZ0|0(a9^L0#jv6Hp(`P7>uW;P7J27v@rxXteoxT%d#g#nmdl+94=%0F^ti zgQ{)Mx};~zSyyx@Q(N6I09LA!XMJhi1$n`LB3}jKggf-v@%HU>Gij!hvS#h)^QDJ; zg>}d0)#SPCX#KjzG$Z=N_qq~2Bby%wR~=3S0$rQH^Jbc0+6Y&jj%ET273Fybw&rlr z^FQeeJzysnT?<{WKA$0GNu{4^n@4d#5!KXKILgw84OobCCqCHTsGH1r5DJPq97}i^ zeNUK<*PU*W&P*vUnH(vq)1esR?={Icr5iDx-Tb8kU@XydiI}ErYUJ^O+#3SC#d`zQ z!<^;ok-nle%>N;;pn(S>c0?WCsVT8_LcOOj*wyM*wYLt?$ElSKuNK_4;mrbe|I|&oYEJ&9 zqxDvEo5^GJJjUq{dbpE>oAZs*j}){eBGo2oQJ_FBZ$lzSaF~*Oo<(hz_Yo}Ft7Ikl ze*@UnZGVSM{y!#ky2*FW`8%J4-_pZ5IlMZTJL z*zjf37y0LY8Gixbq<{qhcm$v@!uJJGPXU1dE~S7_00{y3F2S+@R#U)J0=Pl|zLWSa z0X&le-XnnbrhuygSR()<{dobrKLvb10Kbp|eo+7)CIBBG{Urf>Bn5m_057C~UlG8s zrhrcf;8O%3?dX460G}ZM9|QQT0DdC{{H6dtmjXU7fZt64UlhQXQoxr5@cRUy(98b= z0lb(3UJ}4JQouI_@NEKc+Ut)Pz>yMOW5P?3BoYYSdh~zupa%5|6a28E8oeKH)YG#J zj|bkRbMjCXa^O?`Z=rw68xY5ySA*KH@v~A8jNfiA)keyceqNUnW1gq6d?V{i_Q^B3RxvNkSUlN{JBxR6hHQpThMc!xhIGb+$$PntCm-eD zpZuSDGvlGj`OI2^{6O*j88R8nP<0ZM-|<8iGx(a2y0s+hnl#gy@M@_Jq;wv5L>V;)RqWRaQNCCJ4;uZOcJH7zASH!(AB zO2&uD%LKJ1$MZ??W!!_>A_Y`_8>n1i@>)I)RuJzxh$nIt$hw4ZjbCX}#nSh- z&Fe9OG&MmQktO+cc*lQbe1qsvof}N}>CJ+|zZn^qZRQny!OXQMV`o+a&{J8plmAPI%kJp}^Eyj2 a6hTR#JcB1=XGU#SEy&yZHycX^GXenmXxaAw delta 1281 zcmb7^&r1|x7{?oT$8~?X?uu4B>b}~cHC;P|7em8B4+(Y1TLsO|zWU7T&b-_FKrPHX z6bK6m?{q4vYam2;i=ey;5p?bnNs(^aj#@4w2QaFr+Kf7l(L8l6#Oo`rgDqrZ z>}PA0s-sgAO}lytmvwB~10FdDnF#2th-%byEWOB^6K}MF&D|D`v>f_R z&!CSN`}=6E>tn>`+pY0dEK0EE*aK*sTF9Ul=EIqymf`PsKhgkeGl;s5KMluqsHLmr zpgb6Y#Fq^EOPhvF*s4&?orJo;8u=2k3-;=$dHfBYMv=(F@W$HXdDkftlA!PQ=^JhS z7iqAcy_*x?_1T3o1bh0x&a;o<9D9&TCx7hC3wGG^)SYmrTf}UsSy@wBzDv@VwUe2x z(8v~Sl2wjNUh{`rjhd=~o%ss3{j2NVGHfmT`DGWn#bq`N3D|@MzZ`bfhTCsQzX7b( Bo?-w1 diff --git a/docs/build/html/_sources/contributing/contributing_function.rst.txt b/docs/build/html/_sources/contributing/contributing_function.rst.txt index f426889..a6c3486 100644 --- a/docs/build/html/_sources/contributing/contributing_function.rst.txt +++ b/docs/build/html/_sources/contributing/contributing_function.rst.txt @@ -12,6 +12,20 @@ like to work on. Some of these issues are tagged as :code:`enhancement`. The issue will have a description of the function that needs to be implemented, and where the function code should be included. + +Install the package in development mode +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +To contribute any source code such a test, you need to install the package in +development mode. To do this, run the following command from the root of the +project folder:: + + $ pip install -e . + + +Implementing your function +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + In your function you need to remember to include a docstring that describes what the function does. This is important for users of the software to understand how to use the function. The docstring should be in the following format:: @@ -76,6 +90,7 @@ Checklist | |uncheck| Choose an issue labeled :code:`enhancement` from the issues section. | |uncheck| Familiarize yourself with the structure of the source code. +| |uncheck| Install the package in development mode. | |uncheck| Implement the new function. | |uncheck| Include a docstring in the function. | |uncheck| Implement a test for your new function. diff --git a/docs/build/html/_sources/contributing/contributing_test.rst.txt b/docs/build/html/_sources/contributing/contributing_test.rst.txt index b89a524..44d79c9 100644 --- a/docs/build/html/_sources/contributing/contributing_test.rst.txt +++ b/docs/build/html/_sources/contributing/contributing_test.rst.txt @@ -8,25 +8,29 @@ ---------------------- Navigate to the issues tab of the repository and find an issue that you would -like to work on. Some of these issues are tagged as :code:`enhancement`. The +like to work on. Some of these issues are tagged as :code:`Tests`. The issue will have a description of the function that needs to be implemented, and where the function code should be included. -Testing your function -^^^^^^^^^^^^^^^^^^^^^ +Install the package in development mode +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Before you commit your changes, you need to test your function. To do this, you -need to run the test suite. The test suite is in the :code:`tests` directory. -The test suite is written using `pytest `_. -To run the test suite, run the command from the root of the project folder:: +To contribute any source code such a test, you need to install the package in +development mode. To do this, run the following command from the root of the +project folder:: + + $ pip install -e . - $ pytest tests - ============================= test session starts ============================== - platform linux -- Python 3.8.5, pytest-6.2.2, pluggy-0.13.1 - rootdir: /home/nikoleta/Documents/a-hitchhikers-guide-to-contributing-to-open-source - collected 0 items - ============================== no tests ran in 0.01s ============================== +Running the test suite +^^^^^^^^^^^^^^^^^^^^^^ + +Once you have implemented your test you need to run the test suite to ensure +that your test is working correctly. The test suite is written using `pytest +`_. To run it, , run the following command +from the root of the project folder:: + + $ pytest tests Committing the change @@ -48,11 +52,9 @@ This will open a text editor where you can write your commit title and message. Checklist ^^^^^^^^^ -| |uncheck| Choose an issue labeled :code:`enhancement` from the issues section. -| |uncheck| Familiarize yourself with the structure of the source code. -| |uncheck| Implement the new function. -| |uncheck| Include a docstring in the function. -| |uncheck| Implement a test for your new function. -| |uncheck| Test the function using the test suite. +| |uncheck| Choose an issue labeled :code:`Tests` from the issues section. +| |uncheck| Install the package in development mode. +| |uncheck| Implement the test. +| |uncheck| Run the test suite. | |uncheck| Add the changes to the staging area. | |uncheck| Commit the changes. \ No newline at end of file diff --git a/docs/build/html/_sources/index.rst.txt b/docs/build/html/_sources/index.rst.txt index 73bee38..be79f3e 100644 --- a/docs/build/html/_sources/index.rst.txt +++ b/docs/build/html/_sources/index.rst.txt @@ -14,11 +14,6 @@ streaks, and identify the most frequently occurring elements:: Table of Contents ================= -.. To install the package your computer see the installation guideliens. - -.. The purpose of this package is to help you learn how to contribute to open -.. source projects. For more information, check out the tutorial: - .. toctree:: :maxdepth: 2 diff --git a/docs/build/html/contributing/contributing_function.html b/docs/build/html/contributing/contributing_function.html index 6e33c94..1153273 100644 --- a/docs/build/html/contributing/contributing_function.html +++ b/docs/build/html/contributing/contributing_function.html @@ -52,6 +52,8 @@
  • 3. Contributing to the documentation
  • 4. Contributing a test
  • 5. Contributing a new function
      +
    • Install the package in development mode
      • +
    • Implementing your function
    • Documenting your function
    • Testing your function
    • Committing the change
      • @@ -94,6 +96,17 @@ like to work on. Some of these issues are tagged as enhancement. The issue will have a description of the function that needs to be implemented, and where the function code should be included.

      +
      +

      Install the package in development mode

      +

      To contribute any source code such a test, you need to install the package in +development mode. To do this, run the following command from the root of the +project folder:

      +
      $ pip install -e .
+
      +
      +
      +
      +

      Implementing your function

      In your function you need to remember to include a docstring that describes what the function does. This is important for users of the software to understand how to use the function. The docstring should be in the following format:

      @@ -115,6 +128,7 @@ # code for the function +

      Documenting your function

      @@ -153,6 +167,7 @@

      Checklist
      Choose an issue labeled enhancement from the issues section.
      Familiarize yourself with the structure of the source code.
      +
      Install the package in development mode.
      Implement the new function.
      Include a docstring in the function.
      Implement a test for your new function.
      diff --git a/docs/build/html/contributing/contributing_test.html b/docs/build/html/contributing/contributing_test.html index 3e0d4ee..fd9d1a3 100644 --- a/docs/build/html/contributing/contributing_test.html +++ b/docs/build/html/contributing/contributing_test.html @@ -51,7 +51,8 @@
    • 2. Creating a branch
    • 3. Contributing to the documentation
    • 4. Contributing a test @@ -90,22 +91,24 @@

      4. Contributing a test

      Navigate to the issues tab of the repository and find an issue that you would -like to work on. Some of these issues are tagged as enhancement. The +like to work on. Some of these issues are tagged as Tests. The issue will have a description of the function that needs to be implemented, and where the function code should be included.

      -
      -

      Testing your function

      -

      Before you commit your changes, you need to test your function. To do this, you -need to run the test suite. The test suite is in the tests directory. -The test suite is written using pytest. -To run the test suite, run the command from the root of the project folder:

      +
      +

      Install the package in development mode

      +

      To contribute any source code such a test, you need to install the package in +development mode. To do this, run the following command from the root of the +project folder:

      +
      $ pip install -e .
+
      +
      +
      +
      +

      Running the test suite

      +

      Once you have implemented your test you need to run the test suite to ensure +that your test is working correctly. The test suite is written using pytest. To run it, , run the following command +from the root of the project folder:

      $ pytest tests
-============================= test session starts ==============================
-platform linux -- Python 3.8.5, pytest-6.2.2, pluggy-0.13.1
-rootdir: /home/nikoleta/Documents/a-hitchhikers-guide-to-contributing-to-open-source
-collected 0 items
-
-============================== no tests ran in 0.01s ==============================
      @@ -126,12 +129,10 @@

      Committing the change

      Checklist

      -
      Choose an issue labeled enhancement from the issues section.
      -
      Familiarize yourself with the structure of the source code.
      -
      Implement the new function.
      -
      Include a docstring in the function.
      -
      Implement a test for your new function.
      -
      Test the function using the test suite.
      +
      Choose an issue labeled Tests from the issues section.
      +
      Install the package in development mode.
      +
      Implement the test.
      +
      Run the test suite.
      Add the changes to the staging area.
      Commit the changes.
      diff --git a/docs/build/html/contributing/index.html b/docs/build/html/contributing/index.html index 3b59072..6e48a09 100644 --- a/docs/build/html/contributing/index.html +++ b/docs/build/html/contributing/index.html @@ -132,12 +132,15 @@

      Make a Contribution to listwiz4. Contributing a test

    • 5. Contributing a new function
        +
      • Install the package in development mode
        • +
      • Implementing your function
      • Documenting your function
      • Testing your function
      • Committing the change
        • diff --git a/docs/build/html/objects.inv b/docs/build/html/objects.inv index fcc31b9302522137949824ccf9be80e31f9f7033..3729fb066d109e7945f2a7a6bc79152bf6849ffe 100644 GIT binary patch delta 906 zcmV;519kkj2l5Ayc7K@5a+@#|hWC03b>f+>j_{F}!Z<~U;o;VeJGf=8c| zV2cxoZeYkL&&jsr!tmN`UdB94uFMZ4NXU?oAR&izvxN7KzkgM)Kk#7*!yE@(nZa!y z&@dhlp$#e-b}I^y*(!LeHV=GUHYkuYB_m>CnPSR?HKPMg-5)PvQ(>Gt%ZM}e{!OIt zyE^3;+_uC8kmG`nl_PC?S9ms-(kWDS* zp%(JB60(s(p0quvvT=OIF8VVxjB$9d<&m<8>_|8_Ee%TLV*|DFInnMDGAHd88Y?%0 z^LmP>k9ZnK$kLQ>Zl8p4K=*h~)mV)3YcQ)mIOvb7@_#9g|3u_HaUTq*7u_HFasB3W zL639WDF0I>J{*d14y&N~+FD;~dC_j_jht1D{e(vNmzS=dYW8Drz(QdySRAkjj4YTp z@*8;jmzUjXa+CX(i>vZ%Qj=Ls&$aW$%VJ7~%^RQ#UtZaFl1oQc=4Vby2ZtoCo|9jE zj)0rZBY#@yVq`{J?0J{KR>QvUg@V0IMO!l!-LC3HUdulLNwWlB@W5SO>%`YySD;hi zj?V8m5rYFeb^Pzo-=dlP?<9eQxKIJ$!8XCILaTvS##CKSjOn_wTL23lh&q-hn+4$^ z5TlAv7~!8dVVU$S$NG#ZXuv9x28;+r4j3u$dVib%D^y=Q_9ba+a-Ux}j-g&hdf(bb zJ;)`{-Q5gRFS`$v>ed{#TJx)k>FdBjI-(^-+$3F!ylxuEss1l^%iPY#ZFtcW)k+WrDXDW_c` delta 846 zcmV-U1F`(_2e${1c7K;oZ<{a_!0-MPo{F@SQ)O#+sHR;qwd$c-v{l-%b-)Q$3C_T% z%TD_m`+EB%^Ixz56Ck?<^WN`0^ZsVJfLm6)(0m7Rp1?R`x%|yj0t<3rCFQI*!jdO9 z8Qzc#q9u%3&I`J!xDdQF%8QimvkUWp1PK`u5+vl1mJ4|6*neB~+5_(vFfIt@N(^oa zoX6>a6I!5l!>S^TjH=+R+C1=n;ZY!G%8i7@)t=;BNV9yvsQd6FluBdVIYykR`};^? zcXi4xxN13vAtxmt>yDJ|aR(y>xoSC}+2FckGAFNaTjlYTFJa|-%?lu^f!7^3TzlZd z0v@U|HD72)d4F1MRL-yi$+i5U$}*8QKdRwRBgLMKn0Cv6WqdSPrK|x9Kcxn;VByHR zapbOXbq`$Ipj z-<&S!ab~^pKULzxp%`bd4qB+K^`%x2?WW$yS>@@|JRv`WboExVAMgti9ySh(4=e&B z3+9#nYC}tovkVVL!4=XbKIS6OlxO4<2)4r@uG2Fow?P+Ir|qPk6-`gw^QKiaC1K~y z<0zD-_J2v}ey>Ukitj?ZaP^i0li~=vh)_#3bE+SX~24YM=?% z8+5Y_HOus@jk#Wjn&r8f3!W7{BCHD{&n0!vm7~eC$BDv;@T`wK6{+P#sU)~)|KHSS zT1V%be!s?I`%|S0*;d^_^oDQ`P?CskQ7!psbywyD$Vo7J05n6!U|Nm;u@4SjJH760 YyVC`)WOSXnMP=*H?zmR^59>Q6LiHT2`~Uy| diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js index e2cc57f..cdc044b 100644 --- a/docs/build/html/searchindex.js +++ b/docs/build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["contributing/branching", "contributing/contributing_docs", "contributing/contributing_function", "contributing/contributing_test", "contributing/forking", "contributing/index", "contributing/installation", "contributing/pull_request", "index", "installation/index"], "filenames": ["contributing/branching.rst", "contributing/contributing_docs.rst", "contributing/contributing_function.rst", "contributing/contributing_test.rst", "contributing/forking.rst", "contributing/index.rst", "contributing/installation.rst", "contributing/pull_request.rst", "index.rst", "installation/index.rst"], "titles": ["2. Creating a branch", "3. Contributing to the documentation", "5. Contributing a new function", "4. Contributing a test", "1. Forking and Cloning the repository", "Make a Contribution to listwiz", "<no title>", "6. Pushing to Github and Opening a Pull Request", "Welcome to listwiz\u2019s documentation!", "Installation Guide"], "terms": {"befor": [0, 2, 3, 5, 7], "we": [0, 4, 5, 7, 9], "start": [0, 2, 3, 5, 7], "make": [0, 1, 4, 8, 9], "chang": [0, 4, 5, 9], "sourc": [0, 1, 2, 3, 4, 5, 7, 9], "code": [0, 1, 2, 3, 4, 5, 7, 9], "first": [0, 1, 2, 3, 5, 7, 9], "thing": [0, 1, 5], "do": [0, 1, 2, 3, 4, 5, 7], "new": [0, 3, 5, 8], "thi": [0, 1, 2, 3, 4, 5, 7, 8, 9], "becaus": 0, "want": [0, 1, 2, 3, 4, 5, 7, 9], "keep": 0, "ar": [0, 1, 2, 3, 5, 7, 9], "about": [0, 8], "separ": [0, 1], "from": [0, 1, 2, 3, 4, 7], "main": [0, 1, 7], "To": [0, 1, 2, 3, 4, 5, 7, 9], "directori": [0, 1, 2, 3, 9], "cd": [0, 1, 9], "hitchhik": [0, 2, 3, 4, 9], "guid": [0, 2, 3, 4, 8], "contribut": [0, 4, 8, 9], "open": [0, 1, 2, 3, 4, 5, 8, 9], "now": [0, 1, 4, 5, 7], "type": [0, 2, 4], "follow": [0, 1, 2, 3, 4, 5, 9], "git": [0, 1, 2, 3, 4, 5, 7, 9], "name": [0, 1, 2, 3, 7], "note": [0, 4], "should": [0, 1, 2, 3, 4, 7], "descript": [0, 2, 3], "you": [0, 1, 2, 3, 4, 5, 7, 8, 9], "go": [0, 7], "For": [0, 5], "exampl": [0, 5], "add": [0, 1, 2, 3, 7], "function": [0, 5, 8], "could": 0, "implement": [0, 2, 3, 5], "checkout": 0, "In": [1, 2, 5, 8, 9], "issu": [1, 2, 3, 5], "section": [1, 2, 3, 5], "project": [1, 2, 3, 4, 5, 7, 8, 9], "can": [1, 2, 3, 5, 7], "find": [1, 2, 3, 5, 8], "label": [1, 2, 3], "These": [1, 5], "relat": 1, "choos": [1, 2, 3, 4, 5], "one": 1, "work": [1, 2, 3, 5], "The": [1, 2, 3, 4, 5], "crucial": 1, "part": [1, 5], "ani": [1, 7, 9], "It": 1, "help": 1, "user": [1, 2], "understand": [1, 2], "how": [1, 2, 5], "us": [1, 2, 3, 4, 5, 9], "softwar": [1, 2, 7], "all": [1, 2, 3, 7], "file": [1, 2, 3, 7, 9], "doc": 1, "written": [1, 2, 3], "restructuredtext": 1, "built": 1, "sphinx": 1, "order": 1, "modifi": [1, 7, 9], "need": [1, 2, 3, 4, 5, 9], "your": [1, 4, 5, 7, 9], "prefer": 1, "editor": [1, 2, 3, 7], "If": [1, 5, 9], "have": [1, 2, 3, 4, 5, 7], "visual": 1, "studio": 1, "recommend": [1, 9], "take": [1, 5], "few": [1, 5], "minut": 1, "familiar": [1, 2, 3], "yourself": [1, 2, 3], "structur": [1, 2, 3], "index": [1, 8], "rst": 1, "which": [1, 7], "includ": [1, 2, 3, 5, 7], "other": [1, 5, 7], "split": 1, "differ": 1, "each": [1, 5], "folder": [1, 2, 3], "build": [1, 7], "download": [1, 4], "via": 1, "pip": [1, 9], "python": [1, 2, 3], "m": 1, "instal": [1, 8], "navig": [1, 2, 3, 4, 5, 7, 9], "run": [1, 2, 3, 5, 7, 9], "command": [1, 2, 3, 4, 7, 9], "html": 1, "v5": 1, "0": [1, 2, 3, 4], "2": [1, 2, 3, 5, 7, 8], "load": 1, "pickl": 1, "environ": 1, "done": [1, 2, 3, 4, 7, 9], "mo": 1, "target": 1, "po": 1, "out": 1, "date": 1, "updat": [1, 7], "ad": 1, "remov": 1, "look": [1, 4], "outdat": 1, "none": 1, "found": 1, "succeed": 1, "page": [1, 8], "_build": 1, "browser": 1, "see": [1, 7], "local": [1, 7], "made": 1, "onc": [1, 2, 3, 4, 5, 7], "them": [1, 2, 3, 8], "stage": [1, 2, 3, 7], "tou": [1, 2, 3, 7], "text": [1, 2, 3, 7], "where": [1, 2, 3, 4, 7, 9], "write": [1, 2, 3, 5, 7], "titl": [1, 2, 3, 7], "messag": [1, 2, 3, 7], "an": [1, 2, 3, 5], "necessari": 1, "area": [1, 2, 3], "tab": [2, 3, 5], "repositori": [2, 3, 5, 7, 8, 9], "would": [2, 3, 5], "like": [2, 3, 4, 5], "some": [2, 3], "tag": [2, 3], "enhanc": [2, 3], "rememb": [2, 5], "docstr": [2, 3], "describ": 2, "what": [2, 5], "doe": 2, "import": [2, 8], "format": 2, "def": 2, "function_nam": 2, "argument": 2, "paramet": 2, "return": 2, "valu": 2, "suit": [2, 3, 5], "pytest": [2, 3], "root": [2, 3], "session": [2, 3], "platform": [2, 3, 5], "linux": [2, 3], "3": [2, 3, 4, 5, 8], "8": [2, 3, 8], "6": [2, 3, 5, 8], "pluggi": [2, 3], "13": [2, 3], "1": [2, 3, 5, 8, 9], "rootdir": [2, 3], "home": [2, 3], "nikoleta": [2, 3, 4], "collect": [2, 3], "item": [2, 3], "ran": [2, 3], "01": [2, 3], "5": [3, 5, 8], "document": [3, 5, 7], "most": [4, 8], "protect": 4, "github": [4, 5, 8, 9], "mean": 4, "cannot": 4, "directli": 4, "instead": [4, 9], "creat": [4, 5, 8, 9], "copi": [4, 5, 7, 9], "under": [4, 7], "own": 4, "account": [4, 5, 7], "process": [4, 7], "call": 4, "http": [4, 5, 9], "com": [4, 5, 9], "v3": 4, "click": [4, 7], "button": [4, 7], "Then": [4, 7, 9], "onwer": 4, "comput": [4, 5, 7, 9], "address": 4, "clipboard": 4, "ssh": 4, "protocol": 4, "line": 4, "tool": 4, "past": 4, "just": 4, "usernam": [4, 9], "replac": [4, 9], "httpsgit": 4, "remot": 4, "enumer": 4, "object": 4, "117": 4, "count": 4, "100": 4, "compress": 4, "94": 4, "total": 4, "delta": 4, "14": 4, "reus": 4, "105": 4, "9": [4, 8], "pack": 4, "receiv": 4, "63": 4, "mib": 4, "43": 4, "s": [4, 9], "resolv": 4, "tutori": 5, "learn": 5, "typic": 5, "host": 5, "gitlab": 5, "manag": 5, "educ": 5, "appli": 5, "specif": 5, "here": 5, "more": [5, 9], "initi": 5, "step": 5, "fork": [5, 8, 9], "bring": 5, "clone": [5, 8, 9], "readi": 5, "There": 5, "sever": 5, "task": 5, "test": [5, 7, 8], "nagiv": 5, "branch": [5, 7, 8], "4": [5, 8], "inform": [5, 8], "well": 5, "checklist": 5, "complet": 5, "compil": 5, "commit": [5, 7], "ask": 5, "develop": [5, 9], "instruct": 5, "push": [5, 8], "pull": [5, 8], "request": [5, 8], "thu": 5, "summari": 5, "summaris": 5, "check": [5, 7], "modif": 5, "further": 5, "send": 7, "back": 7, "origin": 7, "listwiz": 7, "One": 7, "so": 7, "merg": 7, "compar": 7, "number": 7, "autom": 7, "variou": 7, "also": 7, "viewabl": 7, "version": 7, "correspond": 7, "detail": [7, 9], "No": 7, "review": 7, "requir": 7, "did": 7, "similarli": 7, "automat": 7, "contributor": 7, "list": [7, 8], "final": 7, "might": 7, "repeat": 7, "itself": 7, "eventu": 7, "allow": 8, "handl": 8, "sort": 8, "longest": 8, "increas": 8, "streak": 8, "identifi": 8, "frequent": 8, "occur": 8, "element": 8, "lwz": 8, "unsorted_list": 8, "10": 8, "7": 8, "sorted_list": 8, "merge_sort": 8, "modul": 8, "search": 8, "packag": 9, "obtain": 9, "refer": 9, "after": 9, "termin": 9, "place": 9, "actual": 9, "next": 9, "mode": 9, "e": 9, "why": 9, "plan": 9, "immedi": 9, "reflect": 9, "without": 9, "reinstal": 9}, "objects": {}, "objtypes": {}, "objnames": {}, "titleterms": {"2": 0, "creat": 0, "branch": 0, "3": 1, "contribut": [1, 2, 3, 5], "document": [1, 2, 8], "check": 1, "modif": [1, 7], "commit": [1, 2, 3], "chang": [1, 2, 3, 7], "checklist": [1, 2, 3], "5": 2, "new": 2, "function": [2, 3], "your": [2, 3], "test": [2, 3], "4": 3, "1": 4, "fork": 4, "clone": 4, "repositori": 4, "make": [5, 7], "listwiz": [5, 8], "6": 7, "push": 7, "github": 7, "open": 7, "pull": 7, "request": 7, "further": 7, "welcom": 8, "s": 8, "tabl": 8, "content": 8, "indic": 8, "instal": 9, "guid": 9}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 6, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 56}}) \ No newline at end of file +Search.setIndex({"docnames": ["contributing/branching", "contributing/contributing_docs", "contributing/contributing_function", "contributing/contributing_test", "contributing/forking", "contributing/index", "contributing/pull_request", "index", "installation/index"], "filenames": ["contributing/branching.rst", "contributing/contributing_docs.rst", "contributing/contributing_function.rst", "contributing/contributing_test.rst", "contributing/forking.rst", "contributing/index.rst", "contributing/pull_request.rst", "index.rst", "installation/index.rst"], "titles": ["2. Creating a branch", "3. Contributing to the documentation", "5. Contributing a new function", "4. Contributing a test", "1. Forking and Cloning the repository", "Make a Contribution to listwiz", "6. Pushing to Github and Opening a Pull Request", "Welcome to listwiz\u2019s documentation!", "Installation Guide"], "terms": {"befor": [0, 2, 5, 6], "we": [0, 4, 5, 6, 8], "start": [0, 2, 5, 6], "make": [0, 1, 4, 7, 8], "chang": [0, 4, 5, 8], "sourc": [0, 1, 2, 3, 4, 5, 6, 8], "code": [0, 1, 2, 3, 4, 5, 6, 8], "first": [0, 1, 2, 3, 5, 6, 8], "thing": [0, 1, 5], "do": [0, 1, 2, 3, 4, 5, 6], "new": [0, 5, 7], "thi": [0, 1, 2, 3, 4, 5, 6, 7, 8], "becaus": 0, "want": [0, 1, 2, 3, 4, 5, 6, 8], "keep": 0, "ar": [0, 1, 2, 3, 5, 6, 8], "about": [0, 7], "separ": [0, 1], "from": [0, 1, 2, 3, 4, 6], "main": [0, 1, 6], "To": [0, 1, 2, 3, 4, 5, 6, 8], "directori": [0, 1, 2, 8], "cd": [0, 1, 8], "hitchhik": [0, 2, 4, 8], "guid": [0, 2, 4, 7], "contribut": [0, 4, 7, 8], "open": [0, 1, 2, 3, 4, 5, 7, 8], "now": [0, 1, 4, 5, 6], "type": [0, 2, 4], "follow": [0, 1, 2, 3, 4, 5, 8], "git": [0, 1, 2, 3, 4, 5, 6, 8], "name": [0, 1, 2, 3, 6], "note": [0, 4], "should": [0, 1, 2, 3, 4, 6], "descript": [0, 2, 3], "you": [0, 1, 2, 3, 4, 5, 6, 7, 8], "go": [0, 6], "For": [0, 5], "exampl": [0, 5], "add": [0, 1, 2, 3, 6], "function": [0, 3, 5, 7], "could": 0, "implement": [0, 3, 5], "checkout": 0, "In": [1, 2, 5, 7, 8], "issu": [1, 2, 3, 5], "section": [1, 2, 3, 5], "project": [1, 2, 3, 4, 5, 6, 7, 8], "can": [1, 2, 3, 5, 6], "find": [1, 2, 3, 5, 7], "label": [1, 2, 3], "These": [1, 5], "relat": 1, "choos": [1, 2, 3, 4, 5], "one": 1, "work": [1, 2, 3, 5], "The": [1, 2, 3, 4, 5], "crucial": 1, "part": [1, 5], "ani": [1, 2, 3, 6, 8], "It": 1, "help": 1, "user": [1, 2], "understand": [1, 2], "how": [1, 2, 5], "us": [1, 2, 3, 4, 5, 8], "softwar": [1, 2, 6], "all": [1, 2, 3, 6], "file": [1, 2, 3, 6, 8], "doc": 1, "written": [1, 2, 3], "restructuredtext": 1, "built": 1, "sphinx": 1, "order": 1, "modifi": [1, 6, 8], "need": [1, 2, 3, 4, 5, 8], "your": [1, 3, 4, 5, 6, 8], "prefer": 1, "editor": [1, 2, 3, 6], "If": [1, 5, 8], "have": [1, 2, 3, 4, 5, 6], "visual": 1, "studio": 1, "recommend": [1, 8], "take": [1, 5], "few": [1, 5], "minut": 1, "familiar": [1, 2], "yourself": [1, 2], "structur": [1, 2], "index": [1, 7], "rst": 1, "which": [1, 6], "includ": [1, 2, 3, 5, 6], "other": [1, 5, 6], "split": 1, "differ": 1, "each": [1, 5], "folder": [1, 2, 3], "build": [1, 6], "download": [1, 4], "via": 1, "pip": [1, 2, 3, 8], "python": [1, 2], "m": 1, "instal": [1, 5, 7], "navig": [1, 2, 3, 4, 5, 6, 8], "run": [1, 2, 5, 6, 8], "command": [1, 2, 3, 4, 6, 8], "html": 1, "v5": 1, "0": [1, 2, 4], "2": [1, 2, 5, 6, 7], "load": 1, "pickl": 1, "environ": 1, "done": [1, 2, 3, 4, 6, 8], "mo": 1, "target": 1, "po": 1, "out": 1, "date": 1, "updat": [1, 6], "ad": 1, "remov": 1, "look": [1, 4], "outdat": 1, "none": 1, "found": 1, "succeed": 1, "page": [1, 7], "_build": 1, "browser": 1, "see": [1, 6], "local": [1, 6], "made": 1, "onc": [1, 2, 3, 4, 5, 6], "them": [1, 2, 3, 7], "stage": [1, 2, 3, 6], "tou": [1, 2, 3, 6], "text": [1, 2, 3, 6], "where": [1, 2, 3, 4, 6, 8], "write": [1, 2, 3, 5, 6], "titl": [1, 2, 3, 6], "messag": [1, 2, 3, 6], "an": [1, 2, 3, 5], "necessari": 1, "area": [1, 2, 3], "tab": [2, 3, 5], "repositori": [2, 3, 5, 6, 7, 8], "would": [2, 3, 5], "like": [2, 3, 4, 5], "some": [2, 3], "tag": [2, 3], "enhanc": 2, "rememb": [2, 5], "docstr": 2, "describ": 2, "what": [2, 5], "doe": 2, "import": [2, 7], "format": 2, "def": 2, "function_nam": 2, "argument": 2, "paramet": 2, "return": 2, "valu": 2, "suit": [2, 5], "pytest": [2, 3], "root": [2, 3], "session": 2, "platform": [2, 5], "linux": 2, "3": [2, 4, 5, 7], "8": [2, 7], "6": [2, 5, 7], "pluggi": 2, "13": 2, "1": [2, 5, 7, 8], "rootdir": 2, "home": 2, "nikoleta": [2, 4], "collect": 2, "item": 2, "ran": 2, "01": 2, "5": [5, 7], "document": [5, 6], "most": [4, 7], "protect": 4, "github": [4, 5, 7, 8], "mean": 4, "cannot": 4, "directli": 4, "instead": [4, 8], "creat": [4, 5, 7, 8], "copi": [4, 5, 6, 8], "under": [4, 6], "own": 4, "account": [4, 5, 6], "process": [4, 6], "call": 4, "http": [4, 5, 8], "com": [4, 5, 8], "v3": 4, "click": [4, 6], "button": [4, 6], "Then": [4, 6, 8], "onwer": 4, "comput": [4, 5, 6, 8], "address": 4, "clipboard": 4, "ssh": 4, "protocol": 4, "line": 4, "tool": 4, "past": 4, "just": 4, "usernam": [4, 8], "replac": [4, 8], "httpsgit": 4, "remot": 4, "enumer": 4, "object": 4, "117": 4, "count": 4, "100": 4, "compress": 4, "94": 4, "total": 4, "delta": 4, "14": 4, "reus": 4, "105": 4, "9": [4, 7], "pack": 4, "receiv": 4, "63": 4, "mib": 4, "43": 4, "s": [4, 8], "resolv": 4, "tutori": 5, "learn": 5, "typic": 5, "host": 5, "gitlab": 5, "manag": 5, "educ": 5, "appli": 5, "specif": 5, "here": 5, "more": [5, 8], "initi": 5, "step": 5, "fork": [5, 7, 8], "bring": 5, "clone": [5, 7, 8], "readi": 5, "There": 5, "sever": 5, "task": 5, "test": [5, 6, 7], "nagiv": 5, "branch": [5, 6, 7], "4": [5, 7], "inform": [5, 7], "well": 5, "checklist": 5, "complet": 5, "compil": 5, "commit": [5, 6], "ask": 5, "develop": [5, 8], "instruct": 5, "push": [5, 7], "pull": [5, 7], "request": [5, 7], "thu": 5, "summari": 5, "summaris": 5, "check": [5, 6], "modif": 5, "further": 5, "send": 6, "back": 6, "origin": 6, "listwiz": 6, "One": 6, "so": 6, "merg": 6, "compar": 6, "number": 6, "autom": 6, "variou": 6, "also": 6, "viewabl": 6, "version": 6, "correspond": 6, "detail": [6, 8], "No": 6, "review": 6, "requir": 6, "did": 6, "similarli": 6, "automat": 6, "contributor": 6, "list": [6, 7], "final": 6, "might": 6, "repeat": 6, "itself": 6, "eventu": 6, "allow": 7, "handl": 7, "sort": 7, "longest": 7, "increas": 7, "streak": 7, "identifi": 7, "frequent": 7, "occur": 7, "element": 7, "lwz": 7, "unsorted_list": 7, "10": 7, "7": 7, "sorted_list": 7, "merge_sort": 7, "modul": 7, "search": 7, "packag": [5, 8], "obtain": 8, "refer": 8, "after": 8, "termin": 8, "place": 8, "actual": 8, "next": 8, "mode": [5, 8], "e": [2, 3, 8], "why": 8, "plan": 8, "immedi": 8, "reflect": 8, "without": 8, "reinstal": 8, "ensur": 3, "correctli": 3}, "objects": {}, "objtypes": {}, "objnames": {}, "titleterms": {"2": 0, "creat": 0, "branch": 0, "3": 1, "contribut": [1, 2, 3, 5], "document": [1, 2, 7], "check": 1, "modif": [1, 6], "commit": [1, 2, 3], "chang": [1, 2, 3, 6], "checklist": [1, 2, 3], "5": 2, "new": 2, "function": 2, "your": 2, "test": [2, 3], "4": 3, "1": 4, "fork": 4, "clone": 4, "repositori": 4, "make": [5, 6], "listwiz": [5, 7], "6": 6, "push": 6, "github": 6, "open": 6, "pull": 6, "request": 6, "further": 6, "welcom": 7, "s": 7, "tabl": 7, "content": 7, "indic": 7, "instal": [2, 3, 8], "guid": 8, "run": 3, "suit": 3, "packag": [2, 3], "develop": [2, 3], "mode": [2, 3], "implement": 2}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 6, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 56}}) \ No newline at end of file diff --git a/docs/contributing/contributing_function.rst b/docs/contributing/contributing_function.rst index f426889..a6c3486 100644 --- a/docs/contributing/contributing_function.rst +++ b/docs/contributing/contributing_function.rst @@ -12,6 +12,20 @@ like to work on. Some of these issues are tagged as :code:`enhancement`. The issue will have a description of the function that needs to be implemented, and where the function code should be included. + +Install the package in development mode +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +To contribute any source code such a test, you need to install the package in +development mode. To do this, run the following command from the root of the +project folder:: + + $ pip install -e . + + +Implementing your function +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + In your function you need to remember to include a docstring that describes what the function does. This is important for users of the software to understand how to use the function. The docstring should be in the following format:: @@ -76,6 +90,7 @@ Checklist | |uncheck| Choose an issue labeled :code:`enhancement` from the issues section. | |uncheck| Familiarize yourself with the structure of the source code. +| |uncheck| Install the package in development mode. | |uncheck| Implement the new function. | |uncheck| Include a docstring in the function. | |uncheck| Implement a test for your new function. diff --git a/docs/contributing/contributing_test.rst b/docs/contributing/contributing_test.rst index b89a524..44d79c9 100644 --- a/docs/contributing/contributing_test.rst +++ b/docs/contributing/contributing_test.rst @@ -8,25 +8,29 @@ ---------------------- Navigate to the issues tab of the repository and find an issue that you would -like to work on. Some of these issues are tagged as :code:`enhancement`. The +like to work on. Some of these issues are tagged as :code:`Tests`. The issue will have a description of the function that needs to be implemented, and where the function code should be included. -Testing your function -^^^^^^^^^^^^^^^^^^^^^ +Install the package in development mode +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Before you commit your changes, you need to test your function. To do this, you -need to run the test suite. The test suite is in the :code:`tests` directory. -The test suite is written using `pytest `_. -To run the test suite, run the command from the root of the project folder:: +To contribute any source code such a test, you need to install the package in +development mode. To do this, run the following command from the root of the +project folder:: + + $ pip install -e . - $ pytest tests - ============================= test session starts ============================== - platform linux -- Python 3.8.5, pytest-6.2.2, pluggy-0.13.1 - rootdir: /home/nikoleta/Documents/a-hitchhikers-guide-to-contributing-to-open-source - collected 0 items - ============================== no tests ran in 0.01s ============================== +Running the test suite +^^^^^^^^^^^^^^^^^^^^^^ + +Once you have implemented your test you need to run the test suite to ensure +that your test is working correctly. The test suite is written using `pytest +`_. To run it, , run the following command +from the root of the project folder:: + + $ pytest tests Committing the change @@ -48,11 +52,9 @@ This will open a text editor where you can write your commit title and message. Checklist ^^^^^^^^^ -| |uncheck| Choose an issue labeled :code:`enhancement` from the issues section. -| |uncheck| Familiarize yourself with the structure of the source code. -| |uncheck| Implement the new function. -| |uncheck| Include a docstring in the function. -| |uncheck| Implement a test for your new function. -| |uncheck| Test the function using the test suite. +| |uncheck| Choose an issue labeled :code:`Tests` from the issues section. +| |uncheck| Install the package in development mode. +| |uncheck| Implement the test. +| |uncheck| Run the test suite. | |uncheck| Add the changes to the staging area. | |uncheck| Commit the changes. \ No newline at end of file diff --git a/docs/contributing/installation.rst b/docs/contributing/installation.rst deleted file mode 100644 index e69de29..0000000 From bb038ad00d8d91b8daa73f1fa1936a8aefabe883 Mon Sep 17 00:00:00 2001 From: Nikoleta-v3 Date: Thu, 22 Aug 2024 22:14:28 +0200 Subject: [PATCH 6/6] update readme --- README.md | 34 +++++++++++++++++++--------------- 1 file changed, 19 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index cd5c3b8..b5731ca 100644 --- a/README.md +++ b/README.md @@ -9,27 +9,31 @@ This repository contains the files necessary for a mock Python package called Any Python project has its own repository and slightly different style, but many things remain the same across projects. This project follows the recommended -structure. Below, you can see several files and folders along with their -purposes: +structure. Below, you can see the various files and folders of the project along +with their purposes: - `.github/workflows`: This directory contains files for running Continuous Integration (CI). - `docs`: Contains all necessary files for the online documentation of the package. This package is built using Sphinx, and you can see the online documentation here: -- `src`: The folder with the source code of the package. Note that the - convention is to name this folder `src/`. In this case, it's - `src/listwiz`. Inside, you will find several Python files and an `__init__.py` - file at the root. + [https://a-hitchhikers-guide-to-contributing-to-open-source.readthedocs.io/en/latest/](https://a-hitchhikers-guide-to-contributing-to-open-source.readthedocs.io/en/latest/). +- `src`: The folder with the source code of the package. The convention is to + name this folder `src/`. In this case, it's `src/listwiz`. - `tests`: This folder contains all the tests for the source code. We usually aim for each file in `src` to have an associated test file in the `tests` folder. -- `.gitignore`: This file lists all the files we want Git to ignore. Our Python - package generates a lot of auxiliary files, and examples of these are listed - here. -- `README.md`: A file that allows us to deploy the online documentation. -- `setup.py`: The file that is run when we install the package. -- `LICENSE`: The file that contains the license information. -- `CONTRIBUTING.rst`: The file with the contributing guidelines. - -Installation notes. \ No newline at end of file +- `.gitignore`: This file lists all the files we want Git to ignore. For + example, our Python package generates many auxiliary files, which are listed + here because we want to ignore them and not push them to our online + repository. +- `.readthedocs.yaml`: A file that allows us to deploy the online documentation. +- `CODE_OF_CONDUCT`: The file that outlines the expected behavior for + contributors/attendees. +- `LICENSE`: The file that contains the license information. Licenses are not + restrictive, even though some people seem to think so. A license lets us know + and informs users when it's okay to use a package and who has the original + rights. +- `pyproject.toml`: The file that is run when we install the package. +- `README.md`: The file that provides an overview of the project and + instructions for getting started.