From eda83d13e7afc538dd3cf85bb3948b6c9022ea6a Mon Sep 17 00:00:00 2001 From: TheDoubleH Date: Thu, 18 Nov 2021 23:53:53 -0800 Subject: [PATCH] Initial Guide to Fork to Pull Request guide --- .../Contributing/ForkAndPR/ForkedRepro.png | Bin 0 -> 5648 bytes .../Contributing/ForkAndPR/fork_button.jpg | Bin 0 -> 6294 bytes content/Contributing/ForkAndPR/index.md | 49 +++++++++++++++++- 3 files changed, 47 insertions(+), 2 deletions(-) create mode 100644 content/Contributing/ForkAndPR/ForkedRepro.png create mode 100644 content/Contributing/ForkAndPR/fork_button.jpg diff --git a/content/Contributing/ForkAndPR/ForkedRepro.png b/content/Contributing/ForkAndPR/ForkedRepro.png new file mode 100644 index 0000000000000000000000000000000000000000..481fd4168f30966aa0d7bb2dc7289a4265bff187 GIT binary patch literal 5648 zcmV+r7VqhaP)Px#1ZP1_K>z@;j|==^1poj532;bRa{vGqB>(^xB>_oNB=7(L6{Sf;K~#8N?VS%) zRaL&nzg+oyQ4kdf{6jW6KBfmEg_(b-(Bjr;X-o5!(Orzbv01oQl<7E*nNl&PlGea_ z%bw<9h#HHhCQgB4m}qI>_y?xcm!pCra`__{#(e{{qd;25kAuC;W_SbcL02XE+U) zP|DNy4P4+@m%FqAv({WhR^b)s+IiBu6nRiO>u26aYjn`@7`OQ6Uy<^18VWA(?>`%; zy_=hmdZY!KkLr5X=3b<9dn2^pwn3X&5A%$>eb@+w`i3ibASMdW%+N^RFI+Th1@-j} z(&r1$J&VX+j_#4h5D*=J9ZBYp9qmD}{jgRMwMR6M1Y*UZ}IiQcwXkT#4x1H8;Xr-BXDeKe=PRv!phCH$f|Ng_N}Qx zp1bX1&N;>Xo%oh~tvyGeW9Ojk=(Tp<+I0pptjE+U7xkrkP@Z1}t+9=CALo8Z9ikEIsCNU zTNxV@C4DlJA^GK0i@@R-v18>leaf{KWUSMpEKH3x^8&Cf!Bd*Bnygw_X!WQpa(*m>00WW&DA_jZ(|%&iZUZw<@#pYE0f=YM~m7~(m`#E z_Ck^$u=ga5k9RNM-1um1LprtpjkDbd^(V7~qV}F^!E;$w4q~a!4VYWfi3-ntNQw5u zG*vfpN}BM<`!wl|!>C$^g@0rsIAgUaZB!7YExd-kPYuMh0X*Ivf;}-E*ZCKsrVcCr)`^gqK?>l?^1?f z%m7}$E z#?!g&D6eWkAuaJq%xeh)_WrkCs`K|O60^uyHn2jJYh;E!puL(D>fp$bHN6mviW#d?R0BlOsFME;%M;+esGf-?Fc zWI_-Yjo@E<6-Q;N5HLOj%Om+$BP8VZl(6(FEPBQ$6c|2;dqD1)^3!b=W2#34`eC^w z6c|*82i2G%mC+5IUW%l}>l$*{I9GYoIORftq3VzLadL%nP8+0&A7GqP)onOfXB4cI z@2Ei2u8gS(jxZQnU})umj&CX9p3)YM1->5A%2`&;2YVx_`Sek||B7rYDZ^R=O=v}0 zH)$maT@DX~@Cl;R(@hWbMwHzNLjvd?>c%b-CUrdO2ADp=*H-8dp#$0Ep}cG5@3xRS z$OgyBYZz+X{>4qmpi{dqE3_X8>)jw_@W(IhRm2WwiVow_;0c)W?>xd8?FO7as>7Dt zDlA=7A^93&_q*}KUNSezB)Q><@nfvTj~bzUu|_#9(+hsewTe+|Oy7lt*3Zdo<$X_M z>V}_@pfPW$pL-)Bm>(Lc>5#@cx=0)3eh6cTEZ~Bdv@>Q_MkEGcIn$uY9Gm;j1;nnp zh%HC1p;aNDT?&RZ@BLYNUV(*oH)QhITZBqpQQRSElD*YW4zEXh^HlCYHey)^t=8U% zxs`kJ9?sgT!ay}YbU@twYP)Th!lTwBxff{r2fqHk1(6AlA)H4!q^1^2SL-m5%$oJ( z9r($IY~M(4EFS9q{bhLf~DBe3Efi!^i*HLa%+bkfB`2A)5S$$CO)EP;bjm=| z0;K~t%MA83J(%}Ee7Mv$+YoH4{q`o3UyNv1k=bUid3GC2*ISvllmY&TCp)va}NKY zt~MZ7vddk-?=Q2bGyhhr*!pY3>79C{%MasPAenXyWuJB#us5Iiirm0Qjq%DdP2-A8 zx&k|8ss>>4{p_F{>7UnFZBH^MX%)86V$-LD(HNDcYX{PE>MXY>yIOEM{}Oid-Jgmw ztL;k~@8kJ!*SE>{#HCe}DwL|k}B{B-@P<*t3LLKt* zs<3dQooD`A$y|`qG+=LGHL|v{{r?My%)O55qtz&QB?J-5o*5d9wVHmYIIhP;w)cKm zzIJ!s1tE3Q;r3X7nffcKrpU=G98qOJ(MhJ-@0Cet+`MgUGKRgc%9H z;t|dj;_Phxsh)t`5vyRVkIHS*F9=UY?jQCvkyQnJdmqdCa0Q5_^!!w01ti3-NOTkV5xd zSx2edr8KU#wWF~wHcu=FK+;Qom_~Ij{oxuSm+?ANn7E_{6N@@bi<<6OlYD;7MWlbo zo-L`vLZ;nP|ICS#wM&a)8@u1`*b58i)02+{p`8Y=>#g7BHv2NnBxy$*CDB3g~_ z{upkx+hPZ1GyZ-cvZGZvRnjcCKevfiscwwX^mn3d+z37YT|~&^!T2V@6Vs?)Phagu z1w8TE??RB|(mBBy6NXP0sj)mv-or1YJObJF=kM=9yuGKG1A~!9=~HM04WY%mn9@g# z3&1X|+Pz&^hO$hahxdKFOnX{V;2@;2dl18)(a?9Jm^rNnd1CF{LHJL19JDt}L@2hg zc`#CiI2vcHd{*z!VP4pjJQ%Zi<0J0(Lec;aRMd1J<76jJb$Cd>6Z!6qa7^P4cJZH& zf}YX14{MiwfxzT-Soo0pzMH;*%%}A_XsdwfnqXunn$17K&EZmG5D1jqQNN4OU&CJh z1K;RjLMZemLSqoz`TU?mMhlq+vHjs|T*|ICB4<-0Qkh`z_rW)5VWwRq!ObHCgW%4G z{c9C_P>3deJlV$R>c*+7ke$jZ719=jA|$%=tm5|fxreK7z6@=4MH#o1Ogj`U=RodHVDBW5D07# zfp1)m4|NDPiU%YF67iWgEzb0aj6g#VDjSkwLzN^v-r+wk7e1@_P?6}Y0V=8cl zgccZDP;{&mSx-Comy_E>Na6_8YlHZ=+d!Ef3&R3Y zzu{gij)wH&6k7p7!sE*hY|`{?J$tn;LPLjr$KRJ!csZnEyHVF&)_ z@pWeMDr|aPnBw(jEY9Am(O8h?juy}|QzA7=oDm#P zO+#I~rWG@m$!Y301X5oa2ksT*6nLV5UoWfWY=YGye_Sw6e=iE4mnT4UIO>zVff!b1 zI9}4yxfo!1GNoGXh>xo-qK&GAkca)c|@G8nQ#y+Ed7ur&facD}^Rh}au zp_ueENq?*T7<-MYEKOD|4Ma2N@Zq8-ac)5=78~O)o#(4PU(J(02F{$N$yiOPS75ct zXAlML>Ph_AHQEKwK)$jL|2p#`a+na}40(D!wAn=_0XAjz3NBE>Fmlo)ta^c`4Zjyt z#rk;qO~m=0`rAp1p3v(OThjKps z@iwweHhwv>?U@oT8G>Jo`k0$1GIhJQAX}Soi+5Fm5FbOUy{pL_O4>$&QgvpkJ}f4$ z?2!+|^5ZR}=93ly1C}W4@X`VUFwWogTaD~E9oeLxeh**0*?Bt?CT^TJ(!W&rC`c_g znG#h0=~BI9N);x88M!YqmHvh=jp_Um5!Pkb6ze&z^NJ($ikTj=MkeS9jx~muS5UP2 z9FmM?K;k}3Ep)YwIRwvg;UGBynU7%WNUTcac~Fpr2BllM0%w_{Q;ILb$R3yyO2(#s zg;i&MW6D2a&toW3m=?E+I4!Nf)yxsdRw)NgH8$y!Jr(aa)C0*z8(8TuWAV(CVOj+9 z1=RBR^O7IK(Z3-}lbSmpf3$Eq%1CC2F|Vy1h_CHeCdF6+&YWSRy?)U@*Vqk!^?G&Zj#Cw*?^> q1OkB#!jupQ1U3l4AP@+w0R9gess;a5Bv_vS0000PQckH@Cd-g z#>NI?OG!hUx3Fxc^fSkV|8v6HF{ngMhL1-9Q*k>aE_^1Aa z_hOFs9RN^UT?{}aJVNK{&=nTCLlPLg!6;?0G zumgy20f0fLhoU4f0PAURdg$a+7eICZ%=WS}7DTunAh9dZ*DU!aV?0B97prznsXu~! zPOi+LBBpz2;|`5lcn5dh!gSS4W`38X^z*rcqwdt*bcQuli?P!ehRn1984Pg=g5%&x zZ78_zPb_dD}@6FZwImK=_+606;tU z@gmsZm4$cb*$8bvkLZtvf0OW>cWuvIjDdFmfF<+S;GAQhr_L+Jmm4hawgAPf*XIyxFAItKdpRG5v&;6@mQqfmJja()JyZpMYmCTR-1NtDG zI*zf%+>Ho86Zp~rL)D0=MCiJ56tn2I6jUebUn-c_Yf_e`*?ZP-J(%W&kx^)?B|~}a2QXAW9u99=~JH1 zlFmM*Z>Mi@jyj2-r#~dv`Nr?t5p?pTR_nxoTMwaI(C<)bSoBjUk)F3b{CL2yDqYJ@ zS+zU6Lt4Mm4-e|L9IWuh=`3rgO>h6i{WRCVa*A)|qZ#E^lMO*^YKxEL4HZ$_JWf&f zW`0_`dsc3xGB>4onDC=)%Lt&>8|op{!>q< z>Fb=26D^n?xUFj>1O&tRX}KOuNJ_^p%ua3V5sFPQc1R5PkBTmtR}jR7F{t_*coiC8 z+=Go&c^;jJzlP2oj?F)adK$>K>@dqnrCS*Kneh&L<~D=>%(cGf+n)`KU+qyYoggEZ zn#|ey$R=MLN2Vy=!)#yvl(a{&bj%&U{O!$0bN9qDk&Wd^_!GDIX#NaaYN4|Jd+oZ= zr5eG)ezLFaI1LEhduIT*R4aSa)s)6@33sI!t}_6t*<3G+_p+uTSyR3B{*}`XaiaCE zkhN2xqp(TASizMF?|G+qyl8}J634KB!HVwsv>R5g=OvmrNglY95}={|=Gt*{6_2?8 z&Jcx^wM2;}jee<6h$T9ePV4Xo1^P!x+6f!{_Ros3^y)mM>-`G*Fxc=)#v#D`x^R^5lIY~f!L;FGkq$#e7% zrud5`m$56X*1PXe+zlFEnR=gSzG3#(RHz`S?jc=XOS7HG$9^|wn^!(Qf%);}8!iS% z;}YctoUECg%+yn^A$5#HJa%7CYrYFLCatUlFiP3fao`XS}!U7s$sVw~l zE`02W;vrw1C6ne|Q7*h9cNt{PuOvvHgiXRr-Nfrh5_UX@)UTHx2zY?hb;>S_2ghD6 z9yL)4uk@7RR*mM$dmob*ewUQ5^nwh;_S05 z+izWF zn}$XDeOSIJcGHfh(zf}bNfd2}S3X_>zQughhBd|TrMfAfCz4vI-uHX9x(oJ(-BlX% zXTV#cbTh3@sPTkQ7T+_ao+BBnvee>~;v2;1jQ8{=w|Cau;4mG@n~f;rjDmI&uI`&{ zon;5S;{rY1kLw+|{V3OEhXOpUc$}BcfHApqBq^M=GYnuFXwxkCCUb!+rXv^NQh9q{ ziD))v<~%A3M_84HuLP8ND2X4Dls0LBn_bhmdLrb00a2yq(HTH3IVW@4Vp7ofmG~T> zZ1In%^~%f$LLYb(4we0eT806KY`=k4XCZjoZ;1O3=_&;gr8QbqHih4G(FMIiKA9k1 zwQD@F87(#X8`5MJHdVRr_=_BT8WYCot0P`pw>#x*KYS}|oK>u;&(4`Z{sDI$)9p6} znJ-#O9@P%#HEZjx!ncXZ{N)RJT1i{eBH2Gs`(4!9x!-2FJG`WL>Jw)yQcSB)$oZJOIefa+Wv1HoUn$aFKxNd( zkojkT?D=^|g&05sfzYvVz}OgI?C-||5E?pwL2`+hl<`VV877~WxkcR5>>e^Ee%Tw^ z<-H8N0=He=9?IOj^B#-&mZgh(&?Y$r%k|ufri)_(j`aDl0h@s4x?NAMeAGWP`YBCn zwS(XnKCId59h-2=)fn7RssDE&M4YMVHLwcMwy%I}W~+64Z{&`U(|v~ThbX+}kj&Ov z!;P`~6D4|#fsPMhCZE`i%^dF zS*Ej12)FoGsT@~C*N(k<>BKNv-vKT+LpapkBgCLc8(zX6$%hW3mn z7HegJ@={I;I6je6%5w&j96kFw4sFi0Yjx2M;LJ~dS${uOJ@oc^DWc3I=Nsp;V6*}3 zbJg(%LHqi+7W`2~A&jSPx~}LL)=LowHNF}bbr7*(Q!{(ujX5J|%ajamRkQ?!o3nmn zAlm839##%4YJD-joJF1|)2cwe7{BC3GY2V$&Zl*gnm_#(`sNnKO?X1e-8V$}j$qEng>StpZC-+>>$allOQ;V6j2MqY zU8z-lWVVeL69OE%v3DgS=Oqvpyz=)UI0*__^c=_|>HWej4UHk>fHXJqsB3Y=#2aZF zP~Ww%^GvL))xlSl{R=$>{|0j$hB1DlXXPpFv&?*-P|6nO zjKTm}RjC4t9amP|VPxHCn>-GggQ1v6da^=cnF8Gv)G=Hxxch~x|FEE8r%=15)=|&>V=$*dBbV$WHXy^S7F%QN& zp(lInWvS>n*9{3<9uki*HUG{Me#DO2#3mU zU@J)TG8l94_F)IHw3my!DVZ?Y743&K8E4gaQb=PpcUwMmS_Fb#*Srsb;}j{Uc}>>%D9UIs)CCzV+h62QX|**s)8+RXiE zE}lOrckv|(LA?8}b|gSP1I!{9-R&X_dFT+0l+AcO!iPhmbf-F$($y$cGFEKTV<*vRHybWCM>Qgoh2B;- zdacbxsyHd$5waWYvB%i4>936Mg*|goOA}{Oj5!p_4kX@e< z@MKEgehibp%T>n8a}$M7EitbwGm^{H!`ciH2p=LRFJsPhzKyImOzUvs%TeO3n~v%1 znQsEoKq(27QOtVDqHO?aq!Qz2X+iY?7;c$DG=$2cgx#29FmZow_r<}L6Y07!-8GTvL5t%XmP84Iyj&gcX!7ws%eyYC3^^35@pqGPD-f5R@l#f$yN6MUL z$IPCIso-w-?kiUfaAd&*=Bl8XQvZHtD6EIiZAA9UR**;08IV?37R*GyqS`bCZeAX6 z_I8jMRRznp6cQ}o9Sca4LMBGUs$)%*$YpL?D@q9gcIdPP9 z(lf50h;dg3S7SvqHid^SnU!<1cPdfEv?{o*C5l6_lcunIJj3OBdinNuh&4*%Bx^~2 zRCHk0#%Dn;@NVDofp!$@PF`8i<6ei?5M2ZzhGS_6?XYOo{1WV#B$;2FPePdwvX}lu z#~L42NJNvtda5@gN>%I%!W#qQYBE7;o}E0+MNSxN|#>!dg@HhPvPBg^Shu3!k+dxD%lSu{gzW_cH1NZ}K&|w{ z5?wv`p*u-CNv_CshGpm3LY`5}x8QUda z!!p`PjCJjQCRg4Ck00)TD!Ahq0x`*z*Nf>=Df*&gLk*R^uY|AlWZ*^z6hfrHCbSi6 z@vsLX$FXHvj4SL~OrNlc*1%_l#P_mj4;GC{HX3U$Nkurim^22PQ#eW#ylv%U=ZLF$ z+Hm4{SGTfSA!N-GKPl80xb}(z;p-bV)cMz6J+k(TO!UOwps+p6A&8`2?cUmm#hPV7MwQ*ft}w^wZq+@wW8p-cE`|b?Sc{3b*mbLuw!@fBHkE1Tk%n`}zJhV^{H9!&Fm&AR5vAqE z!yok1KD)U9pIfFERAAFQDi9TWjMVDvlX8ew&))ezUKH|vsI)O-@+&U8X7-H`T(W;= m(k(wqoFu>*X(-{^uJkgUf2JzV)!3EW&?8o literal 0 HcmV?d00001 diff --git a/content/Contributing/ForkAndPR/index.md b/content/Contributing/ForkAndPR/index.md index eb13b18a..54a0496c 100644 --- a/content/Contributing/ForkAndPR/index.md +++ b/content/Contributing/ForkAndPR/index.md @@ -7,9 +7,54 @@ weight = 100 ## Abstract -(coming soon) +AL Guidelines is a community project, and as such YOU are encouraged to submit corrections and new ideas. In order to get your content included, you must submit a pull request to the GitHub Repository (Located here: https://github.com/microsoft/alguidelines). All Pull Requests are subject to approval by a minimum three admins. + +If You are toying with an idea, but You aren't ready to create a document just yet, you are encouraged to create a project discussion thread here: https://github.com/microsoft/alguidelines/discussions + +{{% notice warning %}} +If You haven't worked in collaboration with "external" GitHub repositories before, please familiarize yourself with that process by visiting: + +https://docs.github.com/en/pull-requests/collaborating-with-pull-requests + +{{% /notice %}} ## Steps +Now that You have decided that You are ready to contribute, these are the steps to take. +{{% notice info %}} +You can read more about this process here: + +https://docs.github.com/en/get-started/quickstart/contributing-to-projects +{{% /notice %}} + ### Step 1: Fork +In order to work on the repository, You must [Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the repository. + +By forking the repository, You essentially create a copy into Your own account. + +Start by going to the GitHub Repository (), and press the Fork ![Fork Button](./fork_button.jpg "Fork") + +Once You have successfully forked the repository, go to your own GitHub repository : ![Forked Repository Representation](./ForkedRepro.png "Forked repository") + +You are now able to clone your own repository to your local pc and start editing using your favorite editor. [Visual Studio Code](https://code.visualstudio.com/) is perfectly fine for this task. + +{{% notice info %}} +You can read more about forking here: + +https://docs.github.com/en/get-started/quickstart/fork-a-repo +{{% /notice %}} + ### Step 2: Branch -### Step 3: Pullrequest \ No newline at end of file +While not necessarily a must, it is always good practice to create a branch off of your forked repository. That will allow you to work on multiple contributions at the same time and won't have to wait for pull requests to be approved before you can continue on your next contribution. + +{{% notice info %}} +You can read more about Branches here: +https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches +{{% /notice %}} +### Step 3: Pull Request +Once you are happy with your contibution, it's time to create a pull request to propose changes into the main project! This is the final step in producing a fork of someone else's project, and arguably the most important. If you've made a change that you feel would benefit the community as a whole, you should definitely consider contributing back. + +To do so, head on over to the repository on GitHub where your project lives. For this example, it would be at `https://www.github.com//alguidelines`. You'll see a banner indicating that your branch is one commit ahead of microsoft:main. Click **Contribute** and then **Open a pull request.** + +GitHub will bring you to a page that shows the differences between your fork and the microsoft/alguidelines repository. Click **Create pull request.** + +GitHub will bring you to a page where you can enter a title and a description of your changes. _It's important to provide as much useful information and a rationale for why you're making this pull request in the first place._ The project owners needs to be able to determine whether your change is as useful to everyone as you think it is. Finally, click **Create pull request.** \ No newline at end of file