From 78f8674fbec4093210e6bae5ba08905f0ee2b7d6 Mon Sep 17 00:00:00 2001 From: ll7 <32880741+ll7@users.noreply.github.com> Date: Mon, 23 Sep 2024 12:26:29 +0200 Subject: [PATCH 1/3] feat: Add vscode settings for GitHub issues queries and branch naming --- .vscode/settings.json | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 .vscode/settings.json diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 00000000..313b272e --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,22 @@ +{ + "githubIssues.issueBranchTitle": "${issueNumber}-${sanitizedIssueTitle}", + "githubIssues.queries": [ + + { + "label": "My Issues", + "query": "default" + }, + { + "label": "Created Issues", + "query": "author:${user} state:open repo:${owner}/${repository} sort:created-desc" + }, + { + "label": "Assigned Issues", + "query": "assignee:${user} state:open repo:${owner}/${repository} sort:created-desc" + }, + { + "label": "All Issues", + "query": "state:open repo:${owner}/${repository} sort:created-desc" + } + ], +} \ No newline at end of file From fc28b7bf4068cff3424f119ba210ebf13947b588 Mon Sep 17 00:00:00 2001 From: ll7 <32880741+ll7@users.noreply.github.com> Date: Mon, 23 Sep 2024 12:43:09 +0200 Subject: [PATCH 2/3] chore: Update branch naming workflow documentation --- doc/00_assets/github_create_a_branch.png | Bin 0 -> 4599 bytes doc/02_development/05_git_workflow.md | 26 +++++++++++++++++++++-- 2 files changed, 24 insertions(+), 2 deletions(-) create mode 100644 doc/00_assets/github_create_a_branch.png diff --git a/doc/00_assets/github_create_a_branch.png b/doc/00_assets/github_create_a_branch.png new file mode 100644 index 0000000000000000000000000000000000000000..c26a06a8e291fa34f5f05341279760d3085703a0 GIT binary patch literal 4599 zcmb`L_ct4E)WDUh9lNnYV-+n8T2!d2ReRKIt)y!2z1te0Mo@yP8C9z`u~&kqs8J(| zA}Cdx25pVk_nh|+cz<|*c%J)w?vMAJdq3y7Z;TAInCN-vDJUqIv>&URP*7a4zISD6C^ z1#6PFx~gfg?RFl6k*P%v{$jrgET;E(-Z?Zr}TY3n5MSe}wZAZX6_ODa;VKls0_Z+E3AE$C?@mQbzk;V-9R##LXZ6goo|8 z$6Aku!TCjnMLz$w$3_t#!^(yxCiSPM+wCGJU)pILLjMX`9r!^=sgyX#F~?%PWv!{g z)5I6Ib8>h}X1-zycE3mK>g!jZ(!rtkZ4)g^>!Vp6xy~(Ei<`^t;vmEF`Q3J{Itear zo1A_4xmCCrzeOFn@ax zN3og5b1noOFoE!(IaCrE;r*fDnTXS7sLMxqtD>ewhacW>YI=-rh%_KMoAmMz>Cx(! zyi&=OQB}>i)XG^Z8u;XA6_ZQs7lTTAkxPEL;*|pdO&(&Y8QuJ&cM`NF%4fk-o`_c9 zjZz(~)h#~BR?DcE%$V$4FV|U)Rs%qGUsil#3UKzg*;n8@U7Q;2oiBU}^(#zU5{mJQ zdG0Kdg98a<-dZtO%#f4+0I~r-T$bjV49jk(W;60_ZhJ2>Nd9^|R#!jypyXYC_wS7t zG6jWqx5LhJOAnb)g?u~N+9_aY5zy@7@Jdc~Q_pxXf9dFV?8(+$hd!zwPP{%(GI-ye z-i`c?W!{?%Cq+4Z1RuC6Kj>5h-8$bE*zfe|RPZU%s2uBJdw(8sf51lhbp+ z`K*QIFh4tbW91d1Lic2O^BfT5a6oyw^i2T1vG_yij$wT3=pvMWh2H+^-SALR90R_ z!K$ma`{&MIe=cLVxPJ8v*E&Es;_Sga76} z^*vTK4b-q-eoH=y^rcD&I;Yp-6JnLWY1f!Fl+4v)a~&!g9?9Z0)HYy0i>5BL3PaH> z^rR64$IW6R(0N{<5>5ncNAx!k7Bf-KEjat}xgONa5_TFhSCAF6t}HHElusdu@{&RPKSnsjwS>v4>Fd3>+)XI0R2t%Er-lp}|6 zKIjq}`D(ttR!36VO+B`N5W!7>Y2-?`Qj%jSRh3yccGt~w`CQu*oCQm1ZaQ6C*<}E8 zob|4{qqG#fO&V*+I`<8x$?=%u!UG7Z2K&a(1FlS;NmFjkvdtFtcVS;bf!rpDPdK__ zXA@MIwRK+gep&PW*o4-t%UL0*)Et`3$o-Rah0T;6IFJX4*lj|=2LkIw<3 z$ve24D6^iHU~!Yo-1Vl2KEb#ZoECk`#+y&wy0qnxDa8@~IvH1CexuDE{nKw`fFZ3- z_i@NTIGVlcrO9U%-WciZz&D{?CfdnjmMdm&FME%To_Q=$n(awMD3I>g%dPK1dDT*7 z8D6>ld+&pEtJMZ*Evr(7wT+UI_~fq)$en<&o0?6JWz`rU3ugouw$5? z^r>;5Yo#N8Vs-6e5+Jh)!Y}U4IHjk!*caHalC|bi#o|tRG<%6$uSwOiJkcbF&Te`f z3^68!fFS^(!S>h~VPc{z8;otDU{~_(lP+g)T}k-Rghuu>8KT}2bE8Fw#ig!S<^hfD zK>@yvDFs}2sFc7=Un=3OyhyPw2F(u_6?kJR6{)x;X}iP|C2uBIh?n6u)B{B$hnP{` z5lIY8@~pDOEQvB(wee?c4f*{YE;19*$OH-h`TFJk-8-pd{EJV0>36qO{-tq*Gx0hq zqoNfOK`y#L!CMESuA^Dy9Y(ZWHeDxCSX#7SHkVib87atx5yvPa{Ao6^)`45GkcCp8 zrnoWRFm>#!+|UG$G3HGJ2md4A9lccteNB_wW9E@uUKf8O8aLE_?;?1}lL^wiAL*ke)yH;Es-P>`w#J)1zbOzfp3LZ*JY&=E|1=eM9e9H8{dumoJL; ziziM#&ADY_fk5NAzbtRnz0&1x(tLY@9`pIdvT)y8#0l)|(IFA@6&Xu#B0+tc$HKRW zC;jDtim5}pxPIo5rG%7#nfkOWo-6ow%=<1uwA;Q@BGz5=7XAR@?ZIFNL78(!8g8LG zq~dG&B|VTJhE-n`FAvnAyLNbujo*+J{i;3LidMK*xa;rm)y}Q$)1jo3fm2E9oFno| zt^wbCEpIcCMw-#DM)l5DXGh9@UzZ%N)~7k5YiEfKbFnlX|M@gmCCFUST6y>(BW8we zFsOsq$7kEUIW?=PY`S4-6U7rpC5e2>XIX_|5`-Ek7(J;suL=RD zfQEd6mb0BV>ug*DXzM?IxGs4!ux%nh#8QYz$-bwU1NcsJ9MRrB8@S8%b_r<{!2PGD zHEU82C2cu#1RHSEk~XiB;eqCVrXIow_GThpgiQ_9S|w5ifN7T(DD~(zS~k<18o*w8 zPeIEZoFBm8CJGJLJn45f_~@NI1f?pyR4bMc%t5nv-i@>%1pfZG8%^rYlnqM7WGYMa zLxzn+#Ck#PuH0w?5B$H~jtUG**!bxP{qHv!a_S3leFdq9Q=kgbuQ|L&eAqCB9|dCL zBT5OU_wJuu-wHN$FOaqq!2PYkvp>JTavpgi*Xm+s>qS*$9VnQWKA0|L>*+__4m^@j zN^==J25^prv>uWDcLz3?!Ws)(#~(pc>*q;38#dr;9?}5LCX)A?`I>$oKImj16OW^( zra^{91Y7%T+;uftRepjEGn0Mi5TQrVcTn}@L(-e7IZp=aWofQ2bb82GS@wje6M_U70?VY2BTUy0GBPuo^@0|Uo zO^TfKtk(YYzCh{KKVw}26)(R@vHpNplDBOh=We?-*3uA6Jj6UHejU$Ej+uw6Vph?~ z)BR)0y%^3Z?)S<9nqi82vO{5fHD&rdcjp%q4m_Vn@EErqPCfANa9&kf`6D9qlfft+ z9$?M;k%Muyt-NZZYypiT&asCoUk!K=`zmtbSw&h`{~^QXqwvr2KQP6XQ@fS!rq!IB z89?8b8`QB@oD~Z)H;zlrv4-gS`2=5|%W;3Jy`FKMR0;qhR>nIUuKxx8tYtlhnnMvC zK>stDiaLG%CrZrAo~_6Y)UoIq0idMNkso*Vu;|x~aAkIx+=g!cpHk`gf1)wvQH z@Cd`v{_iMBzq$Ai zOTa^(h>}~@E_eC8o0@CtuMuxg7h+}Ibk>AQie~oq=!~VRv~)66Z}94XYBv(m!PkY!%k*)3aGO zI9g5GUoMQny9G>bg)k^@cki}v;cF9kCn|`x$dVmoe12S+rS$MYnuY1!$E}`d)v!RO(X}@ENiD0i+izjY z>}shusEH|q)L235VmGl)*78he^~h(0w_sY7e3)Y+W?bOPul<<$+Pd6XK1SsAtC5aL zq=XlbO`k=K6N`dwR7!`s14C6TDqnN$o#gvB(-GWO;m|gkLs-dQ)2~!uj=74jKlY?r zfZVHNiC5_DxZ+~K#9|{gU5^>{2YQKH=0ee;n!)*gyeJ{g8MgVDZzor>yq z&P9U9A!T2Bmv$EzWn@-A*tzjcx98WK6Xk@rVs}D8vDofP1KD{ecsy&&(p$Gg&H20C z&-oW=X>P_XAv6G^u`?sckkO`O#Ke{TCn-0DF}$pQifkRBzbF;0@3_;&`(oPpYA(}@ z8a4bTg|)ATxVc{D;kJufnW)mM;$6J}KF)mnzS%bsK?ej9=iFhkoEx}T6T68d$J(Ym zqivDpJ9_e&S zg?S2cFkI_H|B|SO9}94dq$w0o&ELSeZk$RLen7Jrr3-gwEO&6c=HKGk=>0}|fmixv z!S0D4EeEJvv)P+&C%cMg&FrVzBfl1Q617fy9AUY`c7&5?tBNyBIXuGi^Hu(01AJj= zu(64vJ_Yo>_5$#X*XnlVcFGZKpD^fk87W%MPr18o54&$*OW@`02fAoSZdz zA1G+9pib-r1b1TNs_lH*rNdVMG$HGqF(%A$wx&iBP)(2S+oof>cR- `28-setup-dev-environment` -**Note: You won't need to manually create these branch names in most cases - -GitHub does it for you, when you create a new branch from the issue you are working on.** +### Branch naming workflow + +The following two options are available for creating a new branch: + +1. **Web Interface**: You can create a new branch by clicking the "Create branch" button in the GitHub web interface. +2. **VSCode Extension**: Alternatively, use the "GitHub.vscode-pull-request-github" extension in Visual Studio Code. + +#### Branch Creation Settings + +The `.vscode/settings.json` file in this repository contains settings that automatically name the branch based on the issue number and the title of the issue. + +#### Creating a Branch in the Web Interface + +To create a branch in the web interface, follow these steps: + +![Create Branch](../00_assets/github_create_a_branch.png) + +#### Creating a Branch in VSCode + +In Visual Studio Code, use the "GitHub.vscode-pull-request-github" extension. + +1. Navigate to the "Issues" tab, where you will find queries defined in the `.vscode/settings.json` file. +2. These queries allow you to access different issues. +3. Click the button "->" to create a new branch from the selected issue, check out the branch, and assign the issue to yourself. ### Commit messages From 87059caa13a91f1e746a2a2cc20ac135cde686ee Mon Sep 17 00:00:00 2001 From: ll7 <32880741+ll7@users.noreply.github.com> Date: Mon, 23 Sep 2024 12:46:01 +0200 Subject: [PATCH 3/3] chore: lint --- doc/02_development/05_git_workflow.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/02_development/05_git_workflow.md b/doc/02_development/05_git_workflow.md index 75e46b8e..7e721190 100644 --- a/doc/02_development/05_git_workflow.md +++ b/doc/02_development/05_git_workflow.md @@ -80,7 +80,7 @@ To create a branch in the web interface, follow these steps: #### Creating a Branch in VSCode -In Visual Studio Code, use the "GitHub.vscode-pull-request-github" extension. +In Visual Studio Code, use the "GitHub.vscode-pull-request-github" extension. 1. Navigate to the "Issues" tab, where you will find queries defined in the `.vscode/settings.json` file. 2. These queries allow you to access different issues.