From 07b8282eec6cc300d03d9b449cbc7dda3b5fa16d Mon Sep 17 00:00:00 2001 From: Andrew Hunt <andrew@aghstrategies.com> Date: Fri, 6 Apr 2018 10:09:01 -0400 Subject: [PATCH] Issue tracking: updated roles of GitLab and Jira --- docs/img/gitlab-reference.png | Bin 0 -> 3000 bytes docs/tools/issue-tracking.md | 43 ++++++++++++++++++++-------------- 2 files changed, 26 insertions(+), 17 deletions(-) create mode 100644 docs/img/gitlab-reference.png diff --git a/docs/img/gitlab-reference.png b/docs/img/gitlab-reference.png new file mode 100644 index 0000000000000000000000000000000000000000..6c456df7f8508df876822c59831c01f45b689f78 GIT binary patch literal 3000 zcmcJR`#%%<AIHg3xx^%dhD9RL($TCCwnjOf6kWu~$~8yJWh*Vsb*`&ZE>SpiaOPyn zWy;zrZA%@OVVKckE#xw5F>Nm2oyYn92j9NGydR&(<MV#JU!TYO@qWLapR5zdk=h!@ z8Y(I(+TLF9lPW5z4$3orqq;Im#iH9PDw@gOaCbl4gW1s+vHSrLOR|b!WNkTc{6Q<G zm*ss|MaNj<_tZJd5%=xS5ri$OHZKiYR5th=ykb*xtU|>X0C()!PE@ffA;hHg0dyS? zVRaY6ruSs{Ok0u&-5<Rkz1<=;DckXEMFYDemv+1P`g8AGGUBbPEBEks-dU!KVZSA7 zTpCItW_tP8W^W1rN33UF<=@akYBg2q6=e4qxbL<blu=H8+d~jelrktHy4n-D*BR9N z^Z3Ux*_#3(oMZiC>;_rjuV!f1MDsAiEON#8W-ZL#F479tz2-Bg3aQDbSNGZ2+uIv- zx3#vujE9ZNm$`T+Q8D@}H<DH7;SY!~S%-b_``N6bqtExoq8e<OFZIr*>VF|hhL-{~ zHF%G7x}7c%4{ND`)nSq`$#AkgmE?=~u<w)YtDddIp?SIMc%aJ?;)qN*)mM|Fa#^!C z9>x@jMB~?rii!@F^W$5~T=CcYA<m;X|E<{-+NT1wkaHc(V}Gcf4XyY|OSfiQFK%Pa z9b9vfgly~QpS9npQusG`fb`x)=mYzTPX-d6+F>)M$Hzl48(Q{+Tsr3jauCQ!u$|W1 zDP&vSCT-%|;U>-t=YrB-nqMoM#`y^__le~vw(nz&FjfMZ_eHqpZXUk|_XETNDQct( z;%BCMlxL>sGv=tYuK;@|Sp7tIxdV9q3%4#$Qi6<zJ^UbF{XAHAhGI+_lumU2qXeR8 z_`4FQ#uPHV|0jzhnyKDt(65|0K&Z~`S`B~ym)P~8vb|ZM@K*qg@8}+se^vw9;|-!) z2groHHa{G2`b4Bzq0xMX>bNDsm{f>GWrEu2aXdrHp<8ZQy4E(oy+yM1i$`(z<;lj| zmL1@A4k+3XE~u-jc~-%t7&@T#gD95X`LLZeW)!lAQ{tf5$uFZqkYcqCsMd1eu%BHy zr57@sh-ZgAH>&=UFA1O*#%zQGGPoJ#XKKlM9kpsTt8qX=WOEoLVG=TPu*gMXD^v}P zTa~NNEMAE*os?qYN@Vhd>9)Y<Dz^qH!3RL~-{WP)=&K$QaAnZzy@6>T6=DXPv9_w{ z7@Skc#F80aBddLD#u$g4DgpPt5hSnWNu^SRuDyeUWUM_imBQCCbN%au3Gbd%8n>(* zeWaNVE5~ccxx&ZkV{EfzxUYT^g;%+2;KP&4y$cHqFLKul5s&V3nTlt1b-QUdzU#$) zpq;bpXIzu2I|S3;aJk%6__T7Kmu9JgxfoL;2e5Wfa4_X(i(fjwe|KJ85|Wa(t0@&u z#R}*MeFScKNs`Krnv)3GOQNFS`Ndg&l3TL!KJKW^qsZ*?oAOO`v9RN=bsqDJGS1`8 z+}4&IZ?3IicX3B3wGb5ikrgY4*z^Vmyi=$Y>(vt?-~pjDqSvupLttc<1PtEuza+u# z<5m_1gW=!qE9{h&zuEjK4Nl2aeD+lQ_5KySvIUdu4jhp48d8-YP=wKl5d=wP*u725 zV;g-jf3MhHe6_L4Jb6jFV|YxOb7mWQlD8Lb9{RFWUnki|23IcVc*s3748!)wpnhw) zq?KchOU^T+JGb+AAi?sjX;~+Tzlpg!Q?Sn*tXVz#`+<C45RIgV8B7}rTJlY?%)ev0 zQ2(iE1WEH7Nw=|I-e5x2^5ow#EUYDKFyEw)<=zqCP{75IoIH0jXjwegxai8nhKEBB zDhwEO{`^u~uw<6Et*eXfDHpMJx4$(oDkDL?b&(d!gbk+vi{|ODi)R106;$Yeeiyfl zv$1s9GA^fva*AJPMnmVN%FP5vl{UybzKR)MA7vx*uHjJH93PBQ>_zQO+U-_bP%`R$ z-^G%=>R4bgNe$uldDJ+1oa{0?#-Uym&2_>ZeA}phY5?#$`R8KMtwxuUP&Mx$Q_mYF z_(at<7mvXD2c&nv&4-4L;0>p~6_LclSO_89_zIFY3$Z=56l55N|203_^R%!zfninI zqKd)m=d2WLbRpozzIL6qn!LYmuv-V3Y3eRWz4Ui?a_iH@#VIry96MXDFmOmA>-Q40 z>$s_AS|N@onfN0PpBf&?n|$){2CbK{9s(o!r;}}g2|p9Lub@7+;pnEH37o7j!;tL` zNxBxD`!1f#@Yvpx$6Zi*(D<$+i&=d5UDW{AJE4D8YxuwBgs@2Q_RB<f({nZ*^8BdP zXo4+WpVFcV2{7{UfR6#%yP{}`Vrp@d`M5>kn~BBY!lTz4ZP4^J)A6!Rkic)&z{(zE zH<0LZm^=row#o)0N2um=Mv=Z1Uij8fwC=>NcP4k<9mzejrG*tOIv&0HU@qBMduWPv ztl(`W@DO_Cbs`gf0JZwkz&&~!RbGi%E{H^X@;{+BgeHb#iA=yAAnsKLLX1~@aB_X7 zbLQd`13&)*)p?4=QpFYK;hLL)f8do9N-MrPaEkR^-dh$IkyX(wKkJ&YLw(ry8Wr-G zWD#Z3@TFX}U~|Z}7`P}y5<)A%M9}D~25ZMC^8!k#=1>Q7`g8oNDS2aZXPt)a)WE6g z(m(*BSyCB!x%6$SlFOacU~SKYB|0^?yBc55ie9@Jm-|rUwwc$H0j&}ZpLV(QfMPi3 zmT5xbPUj7nr$2vRY=2WdmpK};ttDj0^I|D0O%la=B`LwL&0PmIU}ZNiTN^r5xw!vU z?Ue$u1GWl9-y#!L&rTv6ZN^Ue3LeL_MHmn5j7s*PCC((}w2wC@F&f+2LBH*5??EM_ zJ*}p(p|UNMS$0ij;){)p`<(m%cBWFnT{1k6$yRrTVXjI7>aW>6@(gdOzRPv1Sm^(= zdDhXZw0gI8OrtS{sUO>SFIqsS+U%sZoG*0(Jr#te6c$g)@k2SykFWow7?3|4s*kHB zG5Pyrw5UENviwMb-IsPfL!l+I%*x2QapApP_Z`DP>2=-AH_?4g!Gg6mlC>#Cqu?kc z9?)CDNC-BcDb~gGm}E9GzrJK!+8A~-5;*&tIs<6rryuC3nS6Ab`>m!!A%gRQ7(1ZM zjtHF`;HL|na+xVBWh(;{TX75FQvr8H2T9TcumM!upmTqY_+RJ-*biCr2Y@<I`o5_4 z2KnxsRrO&`Aryk@454j)GBwKj9?v=)PCxN@A7DkqmxaP6eLly|#y*cI;f1-Nq_gL9 zX0_{H(E51I;vlnv6V9*Qlb$^+Za9xmW2!117x->q-ME0iIitk&P$S84#5gr*qG5R` zbymC3tf2LM@#)3{Xw}yK*e*cCHk16wd`XnL5K&XN3Vqj-j*&l&Sy?b=<$wZS^!%#R znCWKF+fG+Ltv`)d$;i8~IM4Pdfqp7#X8eUU$s%rMD~);G8anO2pjnUzk*hjTB5_Xh j$CBp9G3)<OX=;s&a15&1Sv;fsk*jzkj>GFcLQ?(%+&|=- literal 0 HcmV?d00001 diff --git a/docs/tools/issue-tracking.md b/docs/tools/issue-tracking.md index 9a264a9d..a493b576 100644 --- a/docs/tools/issue-tracking.md +++ b/docs/tools/issue-tracking.md @@ -5,21 +5,33 @@ As of 2017 CiviCRM uses three different system for tracking and managing issues ## Systems -### Jira {:#jira} +### GitLab {:#gitlab} -**[issues.civicrm.org](https://issues.civicrm.org/jira)** +**[lab.civicrm.org](http://lab.civicrm.org)** -Used as an issue-tracking system for: +Used as an issue-tracking system for: -* **[CiviCRM (`CRM`)](https://issues.civicrm.org/jira/browse/CRM)** (including `civicrm-core`, `civicrm-packages`, `civicrm-drupal`, `civicrm-joomla`, and `civicrm-wordpress`) -* [CiviVolunteer (`VOL`)](https://issues.civicrm.org/jira/browse/VOL) -* [Extension Review Queue (`EXT`)](https://issues.civicrm.org/jira/browse/EXT) +* **[CiviCRM](https://lab.civicrm.org/groups/dev/-/issues)** (including `civicrm-core`, `civicrm-packages`, `civicrm-drupal`, `civicrm-joomla`, and `civicrm-wordpress`) +* [civicrm.org website issues](https://lab.civicrm.org/marketing-team/civicrm-website) +* [infrastructure issues](https://lab.civicrm.org/infrastructure/ops/issues) +* *...and some [other projects](https://lab.civicrm.org/explore/projects)* + +GitLab is divided into *groups* containing *projects* which may have *issues*. Issues about CiviCRM itself are opened under projects within the Development Team group. + +!!! info "GitLab Issue References" + With all the groups, projects, and issues, you may wonder how to consistently and clearly refer to a GitLab issue in a commit message, pull request, or other conversation. GitLab has a standard style of `group/project#issue`, where `group` is the slug of the group, `project` is the name of the project, and `issue` is the issue number. + + For example, `dev/mail#1` refers to issue 1 from the Mailing project of the Development Team. + + GitLab displays the issue reference at the bottom of the right-hand column along with a link that copies the reference to your clipboard: + +  ### GitHub {:#github} **[github.com/civicrm](https://github.com/civicrm)** -Used as an issue-tracking system for: +Besides being a code repository for most CiviCRM projects, GitHub is used as an issue-tracking system for: * [buildkit](https://github.com/civicrm/civicrm-buildkit/issues) * [cv](https://github.com/civicrm/cv/issues) @@ -27,20 +39,17 @@ Used as an issue-tracking system for: * *...and many [other projects](https://github.com/civicrm)* !!! note - Some projects (e.g. CiviCRM core) have their repository hosted on GitHub but do *not* use the GitHub issue-tracking functionality. For these projects you will notice there is no "Issues" tab. + Some projects (e.g. CiviCRM core) have their repository hosted on GitHub but do *not* use the GitHub issue-tracking functionality. For these projects you will notice there is no "Issues" tab. - -### GitLab {:#gitlab} +### Jira {:#jira} (deprecated) -**[lab.civicrm.org](http://lab.civicrm.org)** +**[issues.civicrm.org](https://issues.civicrm.org/jira)** -Used as an issue-tracking system for: +Used as an issue-tracking system until early 2018 for: -* [civicrm.org website issues](https://lab.civicrm.org/marketing-team/civicrm-website) -* [infrastructure issues](https://lab.civicrm.org/infrastructure/ops/issues) -* *...and some [other projects](https://lab.civicrm.org/explore/projects)* - -In 2017, CiviCRM began to use a private GitLab installation for *some* projects. +* **[CiviCRM (`CRM`)](https://issues.civicrm.org/jira/browse/CRM)** (including `civicrm-core`, `civicrm-packages`, `civicrm-drupal`, `civicrm-joomla`, and `civicrm-wordpress`) +* [CiviVolunteer (`VOL`)](https://issues.civicrm.org/jira/browse/VOL) +* [Extension Review Queue (`EXT`)](https://issues.civicrm.org/jira/browse/EXT) ## Guidelines for creating issues {:#guidelines} -- GitLab