From 99f849252d8fa817d2979ac00fa60342ae449da1 Mon Sep 17 00:00:00 2001 From: Syrus Dark Date: Tue, 2 Jun 2020 23:05:10 +0530 Subject: [PATCH 01/10] Add Contribution guideline in Readme --- README.md | 40 ++++++++++++++++++++++++++++++++ readme-assets/pull-requests.PNG | Bin 0 -> 13742 bytes 2 files changed, 40 insertions(+) create mode 100644 readme-assets/pull-requests.PNG diff --git a/README.md b/README.md index cefc912d54..287c351a4c 100644 --- a/README.md +++ b/README.md @@ -254,6 +254,46 @@ The issues board is reserved for bugs, and future features planned for Manim. If ## Contributing Is always welcome. In particular, there is a dire need for tests and documentation. +#### Contributing to a Manim Community Fork - General guidelines + +As this is a Fork of [Manim from 3b1b](https://github.com/3b1b/manim), contributing can be a bit confusing. So here is a small guide on it. + +1. First, make a fork of either this Repo or the Repo from which this was Forked. ( 3b1b Repository) +2. Then clone the repository you forked by the command below. + + ```sh + git clone + cd manim + ``` + +3. Now that you have cloned the Repo, before making any changes, you have to enter the commands below to contribute to Manim Community Fork. + + ```sh + git remote add fork https://github.com/ManimCommunity/manim.git + git fetch fork + git checkout -b fork/master + ``` + + The first command says `git` that you are going to make a Pull Request for Manim Community. + Then the second command pulls all the commits from the Fork ( Community Fork ). + The third one changes your current working branch even with Manim Community Fork master. + +4. After that, you can make your changes to contents inside the `manim` directory. Then, you can commit the changes. + +5. Finally, before typing in `git push` enter the command below. + + ```sh + git push -u origin + ``` + + Doing this creates a new branch with the updated contents in Github. + + Then you can make a Pull Request, with the content from Github. Make sure to select `ManimCommunity/manim` instead of `3b1b/manim` as `base repository` and your fork and branch as `head repository`. See the picture below. + + ![pull-requests-example-manim-community](D:\Manim COmmunity\manim\Remove req\manim\readme-assets\pull-requests.PNG) + + + ## License The software is double-licensed under the MIT license, with copyright diff --git a/readme-assets/pull-requests.PNG b/readme-assets/pull-requests.PNG new file mode 100644 index 0000000000000000000000000000000000000000..1f77fc25760c9290c0af5068f4250316773db717 GIT binary patch literal 13742 zcmc(G2T)Vrw=NwK1r;Hp6h#yTBqB=aU;$JVM7oq95s)r5bPx*&0)It1Bq9RR6H4d_ zsDQLYdLV=-EtG^#fCR`3`n&%(@6NpUX70N)Z_hx^;jFB)_P5sFdwqLt-aIhWKYZ}y zK{htF!*_1qddSAcNnu?V9pGX823>A_!unwMeW-tftqdzR$GYKizJC8Y8yhl_f9Ekb z>z?n~Z7W|kHi2*ZKkV&ZUs&I`cJt1y>!yKr)NDqQcy-gSn)yAsov7l-fBD!@MMi2*TS_ zwlWltoU&x_q($;pm^~`ACSEE$=fA1yJhR@t9a^My&G(V(ozkIq^boqn-V2sl`z>!Y?^vK7%|5*2N`l=vaaOcig zxS=;_H!Vrwc$axXOm7%(Yc2NE;;ck46n;WH=+>c2^$$Yb=JcAx>6}o!!4U-KzI{4f zE+Pm?OJJGmW0b%U`OTU++MR2Tt^WW=!2V;lr>ciJXv5!|oJCsb$qRzBRJQ&j|9(`> zNz)XxJ?(Uk9qaB*U!^+S@ZwEN`M2gm075cIPac-U1Jch9%?#X&85g*0`wx7PDJF9E zaLb5zbVGQ_*6&VYuv?t zh~#^U>-D3T6#~l8R`MzycB|*yWT|O&Ypud^%nNPZfRh6tV);&?%G%4iZREM_6t5%d zXNAi!YCRzXbKj&24F_u;TiSRJ-IZU(ktqFD9Vc^Z1{?GjPmoEV-Q);KSgbr~$*s5#_Z{wAm2e~&VJ zybT&VSOa!_+f$X*cS4}I3oV#p<{WAig9P;ZJ`DFHoqi45uEhS0Q!Q6+%2@+U84v|L zB8bif(IPohSI;e zXbGCzhe+GO4_3|C)!4nv*u##(W9x#R0hVhkr@gnoNflozFF&sB7vY54Qf<;>XFPZQ z{(k8ew#&v!Z%Xda`2fxH3URREb%^jn@NtCETg{6pySYa{GrH|!ejqq#e8}CLR}QFj z(v@%t@JV|3-Y31E_V5vQ#&=Y7YmjgJt{4Pj!s=qV$Rl$9H{KvmM+r9E__R3oU)d-4z$qXdksG z+DmVEFou3?8hT_FZk4LxNkU>(5Oy}{+*!}jR#{xbYu_mvm#G@|H5@ipBrA}n6sj?s z_S|9Tmm$)z2T?mwl-v@zyHi~LuBBc>kUzRL-yJ+MG_1VyHSp*YnB|oT^*Ae1&(Q+A zYx2r(7yHA`69Tq8kaG#^Q*U4~Ir3%2NH0Px?G*2!E_I-JqjUtM3I0+#LqR<@~bd?LN&| zxMDeQ>hLP+3#6!a!B*YgqO)Qsh!l&l)(Er{QQ1qfG*-*MIl;7fFYeoezC*cepE^C3 z%-w*bhn`?>SZ#pPBR)NIcw!Y!4oj)$EUU?MZ}fdT)u2@=4^SRFve^c_(OqX+vMND%8MrrO;xCG|RM|#K`S3$zIR!Lr66f7R6lzya``)s zPuD&(?EHA!A$Lr}&b6jN-1ij1_czzpf)%4W`M^Z(W)16bLqj4ku`)0h^eCE%+APZ2ljjLHL?kPJA}^#e}2j}Ak!Hd>?Rbem3gV` zBGFWtleV>%qY^FC6&eiD6J(%ghqo+`L`wpg#;K5auiQ)G@gaZuaeMY=vnSVucg-VH zKXX&_x5Jam^?!dAo+?#(`~McsEmI^@1*m z!2v(-Q7DOE-YVheDSr=I5-Q*wU7u-kUbqqpCD{tR(FbDZDbn^4`Wk_-aqZ=I&oAgb z*gh=!s|_D$8=zlb2@vV7?}T&)YGo-)qZUf-lodL`^4?u@wj`q;$Rk0|yT7XNk~QTe zT@rqHXJX{Yse8~ve=OHIca4K~6e%5|9t32qtP9^A?|gh#qB6bsH1MH4mqwnwx*%c~ z`rTKSVE08{QUySIwMAvyZSgHTo0EP(DkiVUEhb(qx)k{ARHMRe^9 zZN)}5%^TpQo<}Uv!y9TBu4V^p*LT)bG8V3p6e3E}HmWP%FMYY7)&4gj@&9rZaSGa7 zw1^&RIiPmet5D!rUH@2lWYbI>pm%4U+)$?7b#V5E9w+UjNBT}A@qh-a14mcY)cNob z;Kab0V>|Vx8^l|yzQLrzz5KwrDK1JAg)y^YTPs4RB;B(5?2+e&j?Lr#B!J}e?fJeU!ADnhc1?f3R&RaPwp5RMk9(s=di-aBx%_2- zAKw%CaR}7V{&Y{*y)_jZgcffAvopNoZcUfp&eZmD48zuM6*l5Q1Pksw>Op)w&{^GZ z$auS#4&v<#{?reG2dSF_u^R)JK5Y?+Dk)(=K zS)R??u8A^=j%*5ioHs#kmKMUv_q@PkIRYka4`w&U48%n?nTyf@h~%}6^Y%-QB)}vJ z3&KL1SyKwgZ`UkLaNp^de+&rV&3+-nwnu{4M8o(IEn5k!rBOXQq<3aXNB>1cCAQhi zWAl=Is@|w)II3=Eh%_OI(_aKl&#qeNJ*wVmT-3tm8lK&ZZp7{K1J zVf-#=qH#KN6|P`1Y2UvZ*J`6G;MBEt0-ZaS8)@6ug(j^nyxIme;?#amJb4Sid2jEG zA+1X4CLbyqC6g1u3xG2`N zd^A(F|uWs zx+K9(IkGhDeynS28rna{~o>&Q&ce0@n zcW$eJrXbclb71v5Sw4G*9iDzGo_H_~nEW%B=#beNk$qjKeG%zXUT32ZtZVM0(d-u) z*~H?LniD^Qz4OBLU+pGAFVFql{DV|K2M6u-5ya+e7TanDz1rlXOYHyMK3J!D{0Ika zQ88k^WQQf6{vYzZf8^UoYS$Y&QX5N8iV8Evuc2qDKhCTyCiFNAZa52r6=ruk)Mt5wvj zBQA}6s~`;$!NYapFwXf{)v0Y_JLmO5jmyipcZTWgIGLCV=SjO2LBa46Nq-J@_2zrI z=FMpTS3w2MyzC8!*%|Af+u0lH?WtCnBM9qzGieLDBT6%>y%)JCPT?DY_KPLXM-WEG zxF|~E!U$-9v*wFPar=B@aYV81=BFZ^GyLZVZhRsgw0!iy6efTF(W4)eb3=qfr4>DD z5hY7osmM*EwL*YYcib20M5}WD>&AoON$%IL5u9i_i{-|HHL~|56N`W;m^;k#bN)2` zO>ixaKXf;v?=wbC6N9XZqLb_NBDk@}wUP(t*PZW1lPii>CfBEh7Fz>K%8P0KZ{iOV z%{S{FUrvW8SO%DpPEvP0;*tM4BHy3)Vy$4oUAaB|%c`lkQ=QYPNnm9?A5_q-rRYJVZd4d)6&z>KX;7STl&f#}J*2lSIq<%kq`}3*eNt;WwMLNk zlTNOT2ftw!O_)(2$w>=5zus^YA>Yu1R?O_H0>;%mENJS1aP zt%7}=w;TF`DT#pmOGvz4%b?w=tj;5u;~!K2;fU~fwxeXkH@`wq!Y(&RB(#lzT!u1 zoXZ8xpx$Q77`>VWX8&&Nt4Eif%zT~srSNqKVm4H|%JEI>_4=MXcC~;rd((t|hETZRgyy_dWhB>X&+Q?o0=_g3X zjbUTPjwrd^HM$dUlA%y^r~&)AWCwW{)OXz6)~Q~`E1{ez)oyavceC8p;xpwnL`v@p z?d{Gya$5|EpqsrzA;(8e{2LYOH6ZX&NTG3t0!StQTwZ{=xZBI{^&B%;MlJ;B(qx1n zb-nDmGHQ(s7+NwAKXTIR+j!;5P4TTdf+Hf8_pO>{L>4zr7m+rF+r;(7pZ3l?cs{P( zs3UmI-ZYPU;o)aOY(sBRDCh|Ai@dtu4ovMu*eXC+C9{3gn;!ABf!EB=`=0OyH{lE8 zOyTfs5)YLvlJ@gkq^5Q4HPxVyfLb`5hJdPp&I4jHVm3s9FJ1t~K= z71<^`LecsNfZ+tR*jnY!ey zhNexMuZNs-vT9>?AcN=yE@02f7c*j@T7%0`*B6+_)$t#`Tv@g613V~TFJNM8JK=*% z9R;Hv+(lO|L?9Lc)uN8k2_y?=Gk7h#j~)x(VnMfT&Kjm)u+K2Du=2V(+egiTP=nCH z2~*^WAdz44r7^X9 zR5vk*tNCl02*-VBE9VV*7`S1w)>yd582A|27D+R!Cf*pdon!%=`t_-EkvEJO{;aSc zK8`l=>qniOY%cA;U(<2EM$0;1Y0LV0$-4KmmoWN@O_XE(fJ%h9 zYT=ykb*i;9rNOl4G0blvjgwuE4~J|`(9f&$KqcgUvPD)1x2YD22_4PgrUZn`l`jRB zY89&qD%ifwE2^3eTKR?Qw|HIN#GYRw*fj0(b|onz*}8X0E6P!odTn(Yf?^>n$BX70 zr+Olu@AFmH44afu1UN%1i3oYLcO#D`enb9(v6LCfM@te5+Ue8%ok9&qf zkhL*+gr-5;Ww#omoYC3*yxlZ~FR(BJ|FpOY84Lk49zN@*4aofyt+kkYt}xQ5hf$$F zY+>DES&X$weBjs|?w7ZJKT4qOdEF)a`8$PnclvkC8LkOJX4ofhRdpRlgu{xTbv=8N zGS}C#t@H&%vo#GFn|w(9LGS3dTS)6!f88#kE&txZ)tDd6nz66k46=I;GjJXL)TY& zxM;QjF3XOxvr%*OniY)s<7^Jx;#$NUE?zP--h*%3pTM5pqO`p^}xh zust98W^fSu1DmOUQH(exbx@S*3jkx3XUh|CUh+M8*r2lca=hxpE&BET#}Vg;)KZZs zGpZbNRA#Nni;AM3?;B2L)NdsKzxA5~(ddNag(I4ho+F1D$}PiMNtWpf*Rb#qin*1G z?VxYg8(E{2qgmgi7lR_c9{RApm&dd%Vw9Ug2Lt0!21hS6bfn#0rH^KFTLg%@W{xoJ z{J^R0as76ijb;+%cWNMoacd91&h@|ifh^kNlSp;COMmcN4oJ%?>t8yLtS}|^w7EO1 z+g$LwoIS@gl1Gj8VU79B_Ya#DUQBt+mwB7#2W?vN7N~h79LmUr;)SwkR@3RO;3vF5M%^3>KLZ5wwA=#)?h-2M2g7p$q#+%mxokgAvS=;a<;w$gDz8P~9z9-_ z{q&bo`~zHF`ZKYlTYK*kPOLxf>Sb>T=VD{qIL#_SMXzJuGO?Er@o-U041)EmR~0mF zeH0`JvT8>4jCz{WgVi<;D*=AdbIsMKN3v+xjp@KP9<^T^RZt+zZjui;gs z_}@EZ`!U4Xzw)RD90C8lQsi!P!e8b18+`b`l1HsCu&e*0ng5)<{$Ek|94^XH%+~6X z1EmQQGYoCKh-#v%NeLiaB~FBF?mn@zFMFDb^z8?V3dImRveeU1-dg&U8rGKv9hQd( z4Xt2pQ2_WydyGnLQIP%cqPEN$hp%qK+w9Enjx-&L;mlY|Rs5Q&1LmB4;@0RXb(Z|z z)u3d-qbrj}TK8wTXJTohYM|ZsiqG*)-E}Wq2s6Il!ws4xya}}7Mj<{afil;96AI9O zO=xr_z0S`;~jhF}ney zTohSL%=-L7Yea){p5?RN#MZ?o#(Sz2q70>p_IwfO+Fv;_Y1C%GfKJS!ET%uNoRe}W z%K)UwjTSDAtsAs)Ie0z6ir*t#g`cGnT!au{pXmt0sEsB@+xuTTa}i+*BjF6<=DEcC z<&BHZte^p>B(;)-z*15({{}&5PZ`V-Q+%TvA)j<7OT89u z^P-+&kx#JHU)!(xdky!yJzI4UZ*~MmypuRm8M!N5cUtV7kp89kI4LjsJs;V`>I3-1 zM;Z=!!Yvht@bT36u{_}2fS^9vP*(^VyUy^z)&((RLDcz>r#Y--&OKGn(uSfno2TY2pWtd$0(U`&|;`{ zzg#m-f=XPP!`lQ+pLz1M&wcVCPUI1}DcPf+;?l=Qp5++QKMIDCoEtEKSuVb<>rKs> zCHA%>FvZ@Xm7!Jg^;4VyGh+g9uqBuy;JfnOW(ni_A`wYRdYb)liPb>OGa_Kb1Nna` z*fBj}dpqTQ9&a!w2MHu$w+M504Edbxkfm{36u)^a**O-pZg zJYcS(ZGa?oNjt^f%E{X6c${OMZpM0EvO^0Fb|j<{GeR3X>g};=zQ+3=Gptowv%sG! z12^QP$;3BqTMtAmN8;1T$&Ah`10;%Pn6Y87aSAnp+OMZ73w{{gL^AY;YRi!d>Jm*a zg}Xf3RXaI-ALZEoTcgZ>XHF_RmGL5P;?ahRm%(-#+;r*k?B`OGK-j&dN8v{A7Qgh3 z?VPy@NJKY=PvW}D$g#2HhZf}9;BH3(&QfvW?Wt^>yi!Q`ykZb_V!ahq>5&xV>EI+; zS>&@)!JH>*I|18oJ-xr2D6Gz$*f5%{vo4s<@LjtH*8luYQ4|IuUS;mhrNMyMFQE!2 z+^&~+7LU1yL9o=F?Yt7D=#=&>)kU+>@eS8Q`H6Al>pQ9w5wHx1+UgEOOaInI_K@$T zxjxsoYz)P!KO`+BPDwYI8kWqjsQXOpzRPMRtxWe5z#oK=8I3pR=8@f%TTq_~;PgBG z8)(fcqmuhBqng0^u+Fib8!40mlry#J9w0+$k#rVjBQ3L|>%;z@ z038Pc_%@i51E0`xEF&wIUv;C>Ne6dWYSNu!X&X@e-?W9huSgmq_#AWWTvknRgoH^z%>+QNzC&}?yk$$ z#ymlw2gDZA2O-#SLp8|H-~{EYexjmB-W|v7JCB~;Q-Yrr_|UIrAMtdMX&C;xy*oD? zdw+TxjtLqY9e)Fi_Y|6h8x5>GDrVh7wW2PqN;z!l?phkr3e`yJnAD{D48$gx@q`fD z*avR1`7ER6&%ODk>f(rV9{zpmT)rx`qH}dn@ES*6zn=pZEehyH`*FZ6KTn^Hqr+9j0hA2@YbHy$xY!s6)Ad!?8q_m6KOQUH3 zZmb#QCWRV*Pat$H$U!Sec1~Y$JNx&#XLq%2Eh}ENTXw&H z)n$wCu5#~nL9pqG6wm5D%GE{1(b5u=Lj4m+c3+Y^kn*D+nD=W6wpUk=E!6nm#hEtQZQMARjmn$lM zu$vHFk0llR&G>@)$!pc|3%99?RvDmp^3763+YOt`eGq@%&TH@&-E|%U_=WB{tX7UP zkE52pm~??zbJ-#+lRao=IhOhEvorf{88IYDXRmW1+*~&I4Y0Fg!bH_&z~nx9j`(s4 z2@3@kGY5-{=^V1e@LbEYGA_PM%BNh@gkir=z|I3yA(tdW6aKrZr9V9_%nLB#5mugd z*=WDK6Dj-_Xd>lom!G$)t%Ah-%Bha8CK`KJt*-XHx?tru^>tMbt!eu~E17?IZiFe@ z6PmRHS5ULE4M5BHgk>qXS`qKmk1-_%6}-Z-2YOF?twy{9*+%ZV3_*&!*V9(f*XC7h z!SW)6?n(0@uZ00v!Fch^D|4K%FfOkQYiyT-t$doaLlOmfhFdLa&NH7drm_KfOJf6O zVRKo*ZaY0SMCyGn*EPl8*us&?ljM<;axQ!BTIQ3w#6jQocNnZ_eZtGOCs$_TsMA3v zOmN6ObsTp=XmPhC(X;N3-OLyk4ra8T6xE4t3usaVgk+^mh9%sB7kCB<<9rQRN#J## zN8FUoZxOrFeBG5b?U|&-;>E^d4=coe_LEHWnur5-asO6Q^&YsA9U8r4uyp#n7LgRepgUrebTHzf{f1O>!9&BB?+cViIa_+2=YyE|DanZp$DRwW%`{p`6odG^sz3ShaD*`*$>X2U}!#uSe zTUDX~VP7Ad)=J3-SiRat2fvf^@G{k}q@{V(nM*`eq!m?3!>tp-DIZo|hhLYr8Z#Tm zy#<_q-`@7MOtL`vX>pl$p>r(O1ZcK)qxjEq1|naOlzh{g_N+ZV+bA{N_SgNsAY)cW zD>Qi0hs24Y|uP4ySpf)mX;Q$X~^`tT9DeAM2AImlVdJq2e3C3E)@h0l|@_; z9D*(po%60;vpte<4^lJF-I6*429coeY<}*z;LnqW%2AkXt#G$In=RbCxT;LAXNSNV z^tH)>k$nEfbfxo_`gB>}#j9z)1cq2T7UiDRc=+QP$`-CxdrnT(zH~? zBL%6wb*;LkO^4n-Qk*9Gs(UKk!Q0YKKDeKkmELtX);T!MvNCI*nYVmHM=9l0xUV%` zEPdwRO5yHcye!})rsEA{vZbHpiWe2?GU1my0Mamn&Fc;3>c1UJOg*IjrvGqOE&Y~vEE?K=P^!J`*95T;inKaZw}{)a)9O4qkgIVUO*f<1qzU zH2}kaZL^dG8T+L?S$lBfo~9c?eZlKK$L8d^XbN!}H-~Zq9J92tNnyywmeK(JBUto4AGuyg74iDUxyT z1^ufO2Ca^n{e3lXU@k{}%~LhUUda+((Bu-Ch5mI!K|2I+Jzw-ebYhD`Pd%m&!KugD5E$&{=lMC(2>AG(rVM)-&`%ZPZ6ulx~q=B%mR*n?&m z52w?=K1GR4daP-aE{u1qIkCr&%Iu-&l*O?8B?UAg|A}O!)`Ap9uL0$GJTA#^Fn<;G z7%cfkt)!wen1LMy4k;TU%tRYirX3l@yQ?0Hs>M*dE7Y~5nGLv7eLEEzZM%<@A#JLp&B5nc9Y&_43P|QDqdQ_Oq*{Xio9Maw&VD zL`e#p>VoFAd2 zeyl=c`{qVaSKKK9e1CJ%0m~`fYHx3tje9Cb|3s8s@~J~w#T+Jbnuj$+m}3eJ#tkJp zBbAr<_PXt*drU-iZfzF3T4%HU7_b;`d%^@vffp>*SOg;bh*KsC?Xa_i>T!>ljTru^ zI7@}CnZCVm=6MwVI?+lSHF^?Q{KTI5Ok4RPIB&%9+(s)M=bD(l*pW%7G9q4uGK&Iq zJ3X(Ku>y|Qh=V53&EfAzWf9NQ4>~uv-Gc1R#s6i&OG$7F%jTkV>=}lct4>1@F9u_k z)x#{Y3tU4m$N|@6+oOn(7r!P>xSx{nEfnn8?Q-0vH--nbYH7J~Qx>_QFi$&*I(zJB z`$3UIa=^a$Upkm<^nt!?7W=7t4vqI1_X*RZ6}wxTu}yvHbFJ=>A1*N}9u-yt-pS0~ zNzX&2Z@gq3my>uw&ic}5sQwKySlI93mRs>T4^leY-sa)Yz-xpXF|DYDBg6L@10cIn zg=Z|?Pb$Vqz;CeB6KqxS_s z#SpxVZx-Oe>}T!vBWCOkL_mik7w0dh_N=|~KJld8h4|<6X<^3JAs&$#T@=}2Ou#{w z+`1J00W>d())BTE$1E8$9GxcSFNH5CPy3&oJM)5JhANf4?7N;)a37mo@0OXK zyr4RS4>CUKm>i{9?2*%~c|Abl@b< z>uU;qmA^ntRTbNDe$NMERkq_Eo${xRBf{p+aPD_Vip|H&1-&Of2uUFR{|04`}=p5^9*Bb=v46ZjE5;1Eg^H{jpr*gkY5=K}Ir1BQhz2)tJ)JdL# zX~@%Kjic1HLCFJEJ$pm&$E@C+wI3#oZ^2~SRpBW;2_vb@uKR+~{S}JIUj0Gy9{@qu zZ_e@KlkAE0Dn^_K*S?N6R@#XEtR1SmZA43L39{3B6g_G_(0{$5k??TPTadI=b-()T ziQ{>}o5h35l}laQ9{oD)8WtU7Ot#L&!n0oGWJ@`$f%m48hmjE{?Wf|_=v+tUDNUzr zJ6E@l^6{@4~$H$TCt= z6ZeuMoAR6JRy70iF<1Sg!yXb zs`CBuzM=NeCGd2TOK^AKnqK>>am+f#tzRp-ext}M4V0)js^IvMa(+^_W5Er?LZN#f z1$YxwClnFf1iD`swXs4(emv~_`A+kxke1Kd^}qx6f~MC$2zAeRb%0RG>y+qOkjRso zd%_w@WvrcV8C%viS;8QcNNgaQELJ)sj=b)(oQfbSGPZLxcQw#a)^BE^xM zmAHn~aVZjjT0@gLR17Yv2$xWrQ#Gd?H?4Pao|3B$Y0qg8B^OycaB~GUC@IN(% zTh_uii!JM|WjX&;AiP=S1TN}7`I&GLe)~nDfDF>F#*~M0(Cl5XzYekQpY8u!7} Date: Wed, 3 Jun 2020 17:18:08 +0530 Subject: [PATCH 02/10] Move to CONTRIBUTING.md --- CONTRIBUTING.md | 37 +++++++++++++++++++++++++++++++++++++ README.md | 42 +----------------------------------------- 2 files changed, 38 insertions(+), 41 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..1602f27b91 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,37 @@ +#### Contributing to a Manim Community Fork - General guidelines + +As this is a Fork of [Manim from 3b1b](https://github.com/3b1b/manim), contributing can be a bit confusing. So here is a small guide on it. + +1. First, make a fork of either this Repo or the Repo from which this was Forked. ( 3b1b Repository) +2. Then clone the repository you forked by the command below. + + ```sh + git clone + cd manim + ``` + +3. Now that you have cloned the Repo, before making any changes, you have to enter the commands below to contribute to Manim Community Fork. + + ```sh + git remote add fork https://github.com/ManimCommunity/manim.git + git fetch fork + git checkout -b fork/master + ``` + + The first command says `git` that you are going to make a Pull Request for Manim Community. + Then the second command pulls all the commits from the Fork ( Community Fork ). + The third one changes your current working branch even with Manim Community Fork master. + +4. After that, you can make your changes to contents inside the `manim` directory. Then, you can commit the changes. + +5. Finally, before typing in `git push` enter the command below. + + ```sh + git push -u origin + ``` + + Doing this creates a new branch with the updated contents in Github. + + Then you can make a Pull Request, with the content from Github. Make sure to select `ManimCommunity/manim` instead of `3b1b/manim` as `base repository` and your fork and branch as `head repository`. See the picture below. + + ![pull-requests-example-manim-community](D:\Manim COmmunity\manim\Remove req\manim\readme-assets\pull-requests.PNG) \ No newline at end of file diff --git a/README.md b/README.md index 287c351a4c..177d5c9ec7 100644 --- a/README.md +++ b/README.md @@ -252,47 +252,7 @@ Documentation is in progress at [eulertour.com/docs](https://www.eulertour.com/d The issues board is reserved for bugs, and future features planned for Manim. If you need help installing or using Manim, please take a look at [the Reddit Community](https://www.reddit.com/r/manim) or the [Discord Community](https://discord.gg/mMRrZQW) ## Contributing -Is always welcome. In particular, there is a dire need for tests and documentation. - -#### Contributing to a Manim Community Fork - General guidelines - -As this is a Fork of [Manim from 3b1b](https://github.com/3b1b/manim), contributing can be a bit confusing. So here is a small guide on it. - -1. First, make a fork of either this Repo or the Repo from which this was Forked. ( 3b1b Repository) -2. Then clone the repository you forked by the command below. - - ```sh - git clone - cd manim - ``` - -3. Now that you have cloned the Repo, before making any changes, you have to enter the commands below to contribute to Manim Community Fork. - - ```sh - git remote add fork https://github.com/ManimCommunity/manim.git - git fetch fork - git checkout -b fork/master - ``` - - The first command says `git` that you are going to make a Pull Request for Manim Community. - Then the second command pulls all the commits from the Fork ( Community Fork ). - The third one changes your current working branch even with Manim Community Fork master. - -4. After that, you can make your changes to contents inside the `manim` directory. Then, you can commit the changes. - -5. Finally, before typing in `git push` enter the command below. - - ```sh - git push -u origin - ``` - - Doing this creates a new branch with the updated contents in Github. - - Then you can make a Pull Request, with the content from Github. Make sure to select `ManimCommunity/manim` instead of `3b1b/manim` as `base repository` and your fork and branch as `head repository`. See the picture below. - - ![pull-requests-example-manim-community](D:\Manim COmmunity\manim\Remove req\manim\readme-assets\pull-requests.PNG) - - +Is always welcome. In particular, there is a dire need for tests and documentation. Check out [CONTRIBUTING.md](https://github.com/ManimCommunity/manim/blob/master/CONTRIBUTING.md) for more details. ## License From 52794cfa5bb169a486bf1b71f99215e309663175 Mon Sep 17 00:00:00 2001 From: Syrus Dark Date: Wed, 3 Jun 2020 19:48:34 +0530 Subject: [PATCH 03/10] Changes as Requested --- CONTRIBUTING.md | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1602f27b91..0a67f15fe3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,8 +1,8 @@ -#### Contributing to a Manim Community Fork - General guidelines +#### Contributing to the Manim Community Fork - General guidelines As this is a Fork of [Manim from 3b1b](https://github.com/3b1b/manim), contributing can be a bit confusing. So here is a small guide on it. -1. First, make a fork of either this Repo or the Repo from which this was Forked. ( 3b1b Repository) +1. First, make a fork of either this Repository. 2. Then clone the repository you forked by the command below. ```sh @@ -10,7 +10,7 @@ As this is a Fork of [Manim from 3b1b](https://github.com/3b1b/manim), contribut cd manim ``` -3. Now that you have cloned the Repo, before making any changes, you have to enter the commands below to contribute to Manim Community Fork. +3. Now that you have cloned the Repo, before making any changes, you have to enter the commands below to contribute to Manim Community. ```sh git remote add fork https://github.com/ManimCommunity/manim.git @@ -18,10 +18,12 @@ As this is a Fork of [Manim from 3b1b](https://github.com/3b1b/manim), contribut git checkout -b fork/master ``` - The first command says `git` that you are going to make a Pull Request for Manim Community. + The first command tells `git` that you are going to make a Pull Request for Manim Community. Then the second command pulls all the commits from the Fork ( Community Fork ). The third one changes your current working branch even with Manim Community Fork master. + Now there are three repositories that git is keeping track of: the manim community repo (referred to as "fork"), your own fork of the manim community repo (referred to by git as "origin"), and your local repository). + 4. After that, you can make your changes to contents inside the `manim` directory. Then, you can commit the changes. 5. Finally, before typing in `git push` enter the command below. @@ -30,8 +32,10 @@ As this is a Fork of [Manim from 3b1b](https://github.com/3b1b/manim), contribut git push -u origin ``` - Doing this creates a new branch with the updated contents in Github. + Doing this creates a new branch with the updated contents in your fork on GitHub. + + Then you can make a Pull Request to the Manim Community Repo from your fork, through GitHub. Make sure to select `ManimCommunity/manim` instead of `3b1b/manim` as `base repository` and your fork and branch as `head repository`. See the picture below. - Then you can make a Pull Request, with the content from Github. Make sure to select `ManimCommunity/manim` instead of `3b1b/manim` as `base repository` and your fork and branch as `head repository`. See the picture below. + ![pull-requests-example-manim-community](D:\Manim COmmunity\manim\Remove req\manim\readme-assets\pull-requests.PNG) - ![pull-requests-example-manim-community](D:\Manim COmmunity\manim\Remove req\manim\readme-assets\pull-requests.PNG) \ No newline at end of file +Also make sure to pull from upstream/master right before making a Pull Request, resolving merge conflicts locally and only then submitting the Pull Request. \ No newline at end of file From 4d3ce596120af4629914d3ed5e7e36f6b2732a7c Mon Sep 17 00:00:00 2001 From: Syrus Dark Date: Wed, 3 Jun 2020 19:55:49 +0530 Subject: [PATCH 04/10] Fix image path --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0a67f15fe3..226a222709 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -36,6 +36,6 @@ As this is a Fork of [Manim from 3b1b](https://github.com/3b1b/manim), contribut Then you can make a Pull Request to the Manim Community Repo from your fork, through GitHub. Make sure to select `ManimCommunity/manim` instead of `3b1b/manim` as `base repository` and your fork and branch as `head repository`. See the picture below. - ![pull-requests-example-manim-community](D:\Manim COmmunity\manim\Remove req\manim\readme-assets\pull-requests.PNG) + ![pull-requests-example-manim-community](readme-assets\pull-requests.PNG) Also make sure to pull from upstream/master right before making a Pull Request, resolving merge conflicts locally and only then submitting the Pull Request. \ No newline at end of file From 8c6bca84dc1ae405f523f2d930a472631b2ae831 Mon Sep 17 00:00:00 2001 From: Syrus Dark Date: Wed, 3 Jun 2020 20:00:11 +0530 Subject: [PATCH 05/10] Change \ to / --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 226a222709..129e8ce444 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -36,6 +36,6 @@ As this is a Fork of [Manim from 3b1b](https://github.com/3b1b/manim), contribut Then you can make a Pull Request to the Manim Community Repo from your fork, through GitHub. Make sure to select `ManimCommunity/manim` instead of `3b1b/manim` as `base repository` and your fork and branch as `head repository`. See the picture below. - ![pull-requests-example-manim-community](readme-assets\pull-requests.PNG) + ![pull-requests-example-manim-community](./readme-assets/pull-requests.PNG) Also make sure to pull from upstream/master right before making a Pull Request, resolving merge conflicts locally and only then submitting the Pull Request. \ No newline at end of file From 7a9ace428125510263dd6029f351a1b314173ba1 Mon Sep 17 00:00:00 2001 From: Syrus Dark Date: Wed, 3 Jun 2020 20:11:40 +0530 Subject: [PATCH 06/10] Add General Contribution --- CONTRIBUTING.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 129e8ce444..6b46ec0471 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,11 @@ -#### Contributing to the Manim Community Fork - General guidelines +# General Contribution Guidelines + +1. If code changes are being made, please include documentation **following the guidelines in the Wiki** (typings are also welcome, but we can probably do them for you, given the documentation). +2. (For the maintainers of this repo) Label PRs appropriately. +3. Link relevant issues. +4. Ensure compatibility with the latest changes in the repo. + +## Contributing to the Manim Community Fork - General guidelines As this is a Fork of [Manim from 3b1b](https://github.com/3b1b/manim), contributing can be a bit confusing. So here is a small guide on it. From b462fc298f1963cbb76587fad25faa449efbc5ad Mon Sep 17 00:00:00 2001 From: Pg Biel <9021226+PgBiel@users.noreply.github.com> Date: Wed, 3 Jun 2020 11:44:03 -0300 Subject: [PATCH 07/10] names --- CONTRIBUTING.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6b46ec0471..c68c813085 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,11 +1,13 @@ # General Contribution Guidelines +Please take what follows into consideration when contributing to this repository (repo). + 1. If code changes are being made, please include documentation **following the guidelines in the Wiki** (typings are also welcome, but we can probably do them for you, given the documentation). 2. (For the maintainers of this repo) Label PRs appropriately. 3. Link relevant issues. 4. Ensure compatibility with the latest changes in the repo. -## Contributing to the Manim Community Fork - General guidelines +## Contributing to the Manim Community Fork - General instructions As this is a Fork of [Manim from 3b1b](https://github.com/3b1b/manim), contributing can be a bit confusing. So here is a small guide on it. @@ -45,4 +47,4 @@ As this is a Fork of [Manim from 3b1b](https://github.com/3b1b/manim), contribut ![pull-requests-example-manim-community](./readme-assets/pull-requests.PNG) -Also make sure to pull from upstream/master right before making a Pull Request, resolving merge conflicts locally and only then submitting the Pull Request. \ No newline at end of file +Also make sure to pull from upstream/master right before making a Pull Request, resolving merge conflicts locally and only then submitting the Pull Request. From 85379398543b053360ba7a8895b0fa98373e5092 Mon Sep 17 00:00:00 2001 From: Syrus Dark Date: Wed, 3 Jun 2020 20:50:17 +0530 Subject: [PATCH 08/10] Update with asked changes --- CONTRIBUTING.md | 30 ++++++++++++++---------------- README.md | 4 +++- 2 files changed, 17 insertions(+), 17 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c68c813085..441c72be89 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,25 +1,23 @@ # General Contribution Guidelines -Please take what follows into consideration when contributing to this repository (repo). - 1. If code changes are being made, please include documentation **following the guidelines in the Wiki** (typings are also welcome, but we can probably do them for you, given the documentation). 2. (For the maintainers of this repo) Label PRs appropriately. 3. Link relevant issues. 4. Ensure compatibility with the latest changes in the repo. -## Contributing to the Manim Community Fork - General instructions +## Contributing to the Manim Community Fork - General guidelines -As this is a Fork of [Manim from 3b1b](https://github.com/3b1b/manim), contributing can be a bit confusing. So here is a small guide on it. +As this is a Fork of [Manim by 3b1b](https://github.com/3b1b/manim), contributing can be a bit confusing. Because of that, here is a small guide on it. -1. First, make a fork of either this Repository. -2. Then clone the repository you forked by the command below. +1. First, make a fork of this repository. +2. Then clone the repository you forked using the command below (bash/zsh) ```sh git clone cd manim ``` -3. Now that you have cloned the Repo, before making any changes, you have to enter the commands below to contribute to Manim Community. +3. Now that you have cloned the repo, before making any changes, you have to enter the commands below in order to be able to contribute to Manim Community. ```sh git remote add fork https://github.com/ManimCommunity/manim.git @@ -27,24 +25,24 @@ As this is a Fork of [Manim from 3b1b](https://github.com/3b1b/manim), contribut git checkout -b fork/master ``` - The first command tells `git` that you are going to make a Pull Request for Manim Community. - Then the second command pulls all the commits from the Fork ( Community Fork ). - The third one changes your current working branch even with Manim Community Fork master. + The first command tells `git` that you are going to make a Pull Request to Manim Community. + The second command pulls all the commits from the aforementioned fork. + Finally, the third one makes your current working branch up-to-date with Manim Community's master branch. - Now there are three repositories that git is keeping track of: the manim community repo (referred to as "fork"), your own fork of the manim community repo (referred to by git as "origin"), and your local repository). + Now there are three repositories that git is keeping track of: the manim community repo (referred to as "fork"), your own fork of it (referred to by git as "origin"), and your local repository. -4. After that, you can make your changes to contents inside the `manim` directory. Then, you can commit the changes. +4. After that, you can make your changes to the repo's files (the code is in the `manim` directory). Then, you can commit said changes. -5. Finally, before typing in `git push` enter the command below. +5. Finally, instead of typing in `git push`, enter the command below. ```sh git push -u origin ``` - Doing this creates a new branch with the updated contents in your fork on GitHub. + Doing so creates a new branch with the updated contents of your fork on GitHub. - Then you can make a Pull Request to the Manim Community Repo from your fork, through GitHub. Make sure to select `ManimCommunity/manim` instead of `3b1b/manim` as `base repository` and your fork and branch as `head repository`. See the picture below. + Then you can make a Pull Request to the Manim Community Repo from your fork, through GitHub. Make sure to select `ManimCommunity/manim` instead of `3b1b/manim` as the `base repository` and your fork and branch as `head repository` - see the picture below. ![pull-requests-example-manim-community](./readme-assets/pull-requests.PNG) -Also make sure to pull from upstream/master right before making a Pull Request, resolving merge conflicts locally and only then submitting the Pull Request. +Also make sure to pull from upstream/master right before making a Pull Request, resolve merge conflicts locally and only then submit the Pull Request. \ No newline at end of file diff --git a/README.md b/README.md index 177d5c9ec7..162beb492e 100644 --- a/README.md +++ b/README.md @@ -252,7 +252,9 @@ Documentation is in progress at [eulertour.com/docs](https://www.eulertour.com/d The issues board is reserved for bugs, and future features planned for Manim. If you need help installing or using Manim, please take a look at [the Reddit Community](https://www.reddit.com/r/manim) or the [Discord Community](https://discord.gg/mMRrZQW) ## Contributing -Is always welcome. In particular, there is a dire need for tests and documentation. Check out [CONTRIBUTING.md](https://github.com/ManimCommunity/manim/blob/master/CONTRIBUTING.md) for more details. +Is always welcome. In particular, there is a dire need for tests and documentation. + +For instructions, guidelines and other details, please check out the file [CONTRIBUTING.md](https://github.com/ManimCommunity/manim/blob/master/CONTRIBUTING.md). ## License From f22311974c242b824577b654c78de63171a8c73f Mon Sep 17 00:00:00 2001 From: Pg Biel <9021226+PgBiel@users.noreply.github.com> Date: Thu, 4 Jun 2020 10:55:58 -0300 Subject: [PATCH 09/10] dot --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 441c72be89..c407d3afe5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,7 +10,7 @@ As this is a Fork of [Manim by 3b1b](https://github.com/3b1b/manim), contributing can be a bit confusing. Because of that, here is a small guide on it. 1. First, make a fork of this repository. -2. Then clone the repository you forked using the command below (bash/zsh) +2. Then clone the repository you forked using the command below (bash/zsh). ```sh git clone @@ -45,4 +45,4 @@ As this is a Fork of [Manim by 3b1b](https://github.com/3b1b/manim), contributin ![pull-requests-example-manim-community](./readme-assets/pull-requests.PNG) -Also make sure to pull from upstream/master right before making a Pull Request, resolve merge conflicts locally and only then submit the Pull Request. \ No newline at end of file +Also make sure to pull from upstream/master right before making a Pull Request, resolve merge conflicts locally and only then submit the Pull Request. From 038936bec34eeeac57733f4243319ab9c8d20b7c Mon Sep 17 00:00:00 2001 From: Syrus Dark Date: Fri, 5 Jun 2020 18:53:22 +0530 Subject: [PATCH 10/10] Change name --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 441c72be89..8698c59361 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,7 +5,7 @@ 3. Link relevant issues. 4. Ensure compatibility with the latest changes in the repo. -## Contributing to the Manim Community Fork - General guidelines +## Contributing to the Manim Community Fork - General instructions As this is a Fork of [Manim by 3b1b](https://github.com/3b1b/manim), contributing can be a bit confusing. Because of that, here is a small guide on it.