From b5082cd0726e6e9d84b49cdf4182b5f0a4a60e0a Mon Sep 17 00:00:00 2001 From: wusongqing Date: Tue, 2 Nov 2021 18:04:05 +0800 Subject: [PATCH] updated contribution docs Signed-off-by: wusongqing --- ...buting-code.md => code-contribution.md.md} | 2 +- en/contribute/documentation-contribution.md | 72 ++++++++++-------- .../figures/Signed-off-by-example.png.png | Bin 0 -> 12690 bytes ...41\347\214\256\346\226\207\346\241\243.md" | 6 +- 4 files changed, 46 insertions(+), 34 deletions(-) rename en/contribute/{contributing-code.md => code-contribution.md.md} (94%) mode change 100755 => 100644 create mode 100644 en/contribute/figures/Signed-off-by-example.png.png diff --git a/en/contribute/contributing-code.md b/en/contribute/code-contribution.md.md old mode 100755 new mode 100644 similarity index 94% rename from en/contribute/contributing-code.md rename to en/contribute/code-contribution.md.md index 495037779a..740bee3e7d --- a/en/contribute/contributing-code.md +++ b/en/contribute/code-contribution.md.md @@ -1,4 +1,4 @@ -# Contributing Code +# Code Contribution ## Start Contributions diff --git a/en/contribute/documentation-contribution.md b/en/contribute/documentation-contribution.md index 61b9c76801..3db5760e94 100755 --- a/en/contribute/documentation-contribution.md +++ b/en/contribute/documentation-contribution.md @@ -1,59 +1,71 @@ -# Documentation Contribution +# Documentation Contribution -You are welcome to make contributions to documentation. You can offer your feedback and contributions in various ways. You can evaluate available documents, make simple modifications, provide feedback on document quality, and contribute your original content. +You are welcome to make contributions to OpenHarmony documentation, in any of the methods provided below. You can help us improve the existing documents or submit new, original content. Excellent contributors will be awarded and the contributions will be publicized in the developer community. -- [Contribution Method](#section5723203852414) +- [Contribution Methods](#section5723203852414) - [Writing Instructions](writing-instructions.md) ## Content Copyright -The content and pictures submitted by users must be original content and must not infringe others' intellectual property rights. +The content and images submitted by you must be original and must not infringe others' intellectual property rights. -OpenHarmony has the right to modify the content that is adopted according to the community regulations and specifications. +OpenHarmony has the right to modify the adopted content according to the community regulations and specifications. ## License [Creative Commons License version 4.0](https://creativecommons.org/licenses/by/4.0/legalcode) -## Contribution Method +## Contribution Methods -## Simple Modification +### Submitting Issues for Existing Documents -You can perform the following steps to modify a document or supplement some content: +Your feedback matters. Submit issues and leave as detailed information as possible, so we can better fix the issues and improve our documents. -1. In the upper right corner of the document page, click **Edit** to go to the source file page in the Gitee project. -2. On the page of the source file in **.md** format, click **Edit** to modify or supplement the file. -3. After the modification, click **Preview** to confirm the modification result. -4. Enter your comments and supplementary information in the **Extended Information** text box and click **Submit**. +1. On the Gitee page, click the **Issues** tab. On the displayed page, click **New issue**. Then enter the issue title and issue details. +2. Click **New** to submit the issue. The Docs team will confirm the issue. - The document team will review your modifications and update the file content accordingly. You will be appreciated for your support and contributions for the OpenHarmony documentation. +>![](public_sys-resources/icon-note.gif) **Note:** +>**How can I provide a high-quality issue?** +> +>- Provide a clear description of the issue, including the missing, outdated, incorrect, or to-be-improved content. +>- Explain the impact of this issue on users. +>- Limit the scope of the given issue to a specific task. If multiple fields are involved, break the issue down into smaller ones. For example, "Documents need to be optimized" is a broad issue, whereas "XX development guide lacks introduction to step XXX" is specific and operable. +>- Search the list of existing issues to see if any related or similar issues have been submitted. +>- If an issue is associated with another issue or a pull request (PR), you can use its full URL or the combination of the number sign (#) and PR number to reference it. +### Editing Existing Documents -For more information, see [Contribution Process](contribution-process.md). +You can perform the following steps to modify or supplement a file: -## Feedback on Documentation +1. In the upper right corner of the document page, click **Edit** to go to the source file page in the Gitee project. +2. On the page of the source file in .md format, modify or supplement the file. +3. After the modification, click **Preview** to confirm the modification result. +4. Enter your comments, supplementary information, and Signed-off-by information in the **Extended Information** text box, and click **Commit**. -High-quality feedback helps us continuously improve the documents. The more detailed information you provide, the more helpful it is for us to solve problems. + Format of Signed-off-by information is as follows: -1. On the Gitee page, click the **Issue** tab. On the displayed page, click **New issue**. Then enter the issue title and issue details. -2. Click **New** to submit the issue. The document team will confirm the issue. + Signed-off-by: user.name <user.email> // Note that *user.name* and *user.email* must be the same as those used for DCO signing. ->![](public_sys-resources/icon-note.gif) **NOTE:** ->**How can I provide a high-quality issue?** ->- Provide a clear description of the issue, including the missing, outdated, incorrect, or to-be-improved content. ->- Explain the impact of this issue on users. ->- Limit the scope of the given issue to a specific task. If many fields are involved, break the issue down into smaller ones. For example, "Documents need to be optimized" is a broad issue, whereas "XX development guide lacks introduction to step XXX" is specific and operable. ->- Search the list of existing issues to see if any related or similar issues have been submitted. ->- If an issue is associated with another issue or a pull request, you can use its full URL or PR number with the number sign \(\#\) to reference it. + ![ ](figures/Signed-off-by-example.png) + + The Docs team will review your edits and update the file accordingly. + + +For more information, see [Contribution Process](contribution-process.md). + +### Contributing Documents to a Release + +To help developers efficiently use each release, OpenHarmony provides related documents (such as development guidelines, API reference, codelabs, release notes, API changelog, and FAQs) based on the requirements planned for the release. Some requirements involve new features and documents, and some require updates to the existing features and documents. -## Content Creation +You are welcome to contribute documents to the release. For details, see [Writing Documents for a Release](docs-release-process.md). -You are encouraged to summarize experience and create technical content during learning and development to help more developers quickly get started. Tutorials and FAQs are recommended. The following templates are for reference: +### Sharing Experience -- [Tutorial: Title \(Task Name\)](tutorial-title-(task-name).md) -- [Title \(Briefly Describe the Key Information of the Issue.\)](title-(briefly-describe-the-key-information-of-the-issue-).md) +You are welcome to share your experience and expertise with other developers to help them get started. For example, you can contribute tutorials and FAQs by using the following templates: -The writing templates are archived in the **contribute** folder in the **Docs** repository. +- [Tutorial Template](template/tutorial-template.md) +- [FAQ Template](template/faq-template.md) +More writing templates are available in the **contribute** folder in the **Docs** repository. diff --git a/en/contribute/figures/Signed-off-by-example.png.png b/en/contribute/figures/Signed-off-by-example.png.png new file mode 100644 index 0000000000000000000000000000000000000000..15bd604ff70722841cdf53964384676ed09384bf GIT binary patch literal 12690 zcmeHtcT`hbw=W(&;874!5u|$XC`i+Y^lHU|f>MHX6Cp?oMF78 zBoI1MqO`z)&;mrkfIvbBkOT-xZo;|mkN3uX-?;aEZ;bDa_ud~Fd#~)h)|zYXwdS0^ z-<)w)cg@8P$Q%$75)!+4h`MRNzJLKBgPY(`UnreU2e=i16{ZZqju@7^AfwIAgz)xhLNH&cLidTxQ9Q8>?FZ9-Z?Xovv)7R zDmQuHt?XC~wu}P|aMc3b3oDMRAukmtFU%;WO7$>g3FlmrQb~#lC9^}JOQswzQRej~ z`da%YrL{pV%6mSQ?#LS}0nuD@;}X#Q0X$6A=4cG8>kC$Su5&Aa{0o0NA)R9F7?75^ z2*_>BbEKD?1lByG=<1lM&AkkHuLCP?*^>`{oDsd7tCYMC*AoaFVdnIVoa`{^+3Q3hSOp6>nUZB&Cd)Sd(^?3Rgj8DW# zo80d^q>vN8xVRYjF7^$G(J-X-q`tncnL~cJ4uB(aoWCTuOZP=9WF?2F>qwR4m)F%z z|D?&?=+e__RSRMG#oa-Jri+Oy3Fl_CWm2MMpN;>)3+Zc3z0-vm-!Y?Xw{hret7XFS`w{mo%|;kjfsOOPv@hvO73?wa;c!f@MjD z+YqH{s9h5B$k)`M3`tjrat|2D=#nltFQHx+4o9TvRO*j9$D3U)QoQW)+(-gB^| zFiI7)+TK3yfI=)q&4(2XJeqTVsKB2*ZNrR&Y??@>(_1r9i; z3_({?IPgjH&Np*oJ~@@oETzy;zT_W*1J4W7Xx{2T4QAgQJbut`{)bhf=KTW9$o4h0 z$u$=6RcP3_ZL=MxZT0!OI?U8JTWMyU8@tsTK+ni^cZKdS;x@Ytp`Bl$3Q1L5Hh3N0 zD;A)y>H39A}WF|MD9&H&meaoHr0V8&dt?Qsd zM5YqqvW{x+@KX_ai4=v}wlKuj&kOwKCSKjESz(z3u+%<+}(Z8=wyoYeq8$OuP=88rd944s}ecsvo`3 z#xWQs`4kwvt_!n!UV06!R`bppJcYiV=Fnm!2~Jv7g|c%Jv8P9)qnAPpU)DZ&473Rg zF1LwH1Ltbgc5-Yu-5mN$!&d2l#VWncwcdcOTP%w-*j`nIPk;^|-F`3}G6!kzNx`QzEkNbZ#6q zl)@;?SaIm9A8diWk7KO(5~i;~{E}Z_K17ICb#-g0jj=?jsC@ww4fC0xB5rekPxYtI zRrB_beZ3p1($0p}8$^Ha>ZbNJ3&+Bx8EZ~x0xN%NGeV_(@tO)}6T=!jsmynmQPO|39by0rB( zh~E?{FTO9zzdZe3`VZZ1&HOXwf@X_+hNg3}TK9tB+q%iuBkdB1P|`8uY*TyGgNb*S ztBel!!dmC9D8{m;ia+m;n@s}(QJs#a?646pw56vqHWrHBf4H(Gq&`a2;9)2zr0Mx9zm{+vC>GMv{(GRLxS>qPj%Rg2) z49Zw4H3gPmw>(pswKF-kJjItvXzcEVG*FN=TS}~K6tw!)#=_E4x47(uL}6pYPgr>{ zz}63H0cZD$6&*|s*hzaM9T%SCa#2qvE^djgjGLXx^J=r51V}I3RXzjeZ>|kiwS2bLry(sPYkoq*+lu`Q)fU z;M*8X`P+AEZpAsi`#_BzU|5ZeDwLx2-94vrB_C)s8-igWio@2ul%VE_+H=B|{nyQZx8G{w&n7fl!{5l- zmrHxTt_4}gfHrKfgHOCJ=J_VoXiKG%-4+d(IFWKlfmNqr7 zefD3dcl93hlyoA~Z`%ftsj-ZOyD;HM+bt;(icAs`ncn?!Ehtg3w5bH`X)_uup4WOS zNwtNp=du;}yy;r4aknF2Kaas#6ByU0u4=QeEXe?CrqCC>FOtd{&b+&!jp#*yQ#D?jvXV~^xDEjZ zqja2orN`5aqvv{mLCjU0uohU{acQshtiY&iraMC~H#czz*Sb(KvhBUF{k453R|OjU z_!j*LxD2=0MO*cU{@uJnIJK67g|#)lj}!#)Lh1h{SXNVPMZq{|LNR}sd+5`K0M&;rKC$8-}BQ^P z(adkB$e#?}u0aIq`g39Fauwf$XdBB9lP@+Qom!u-R}y-$8yE8K|LaXatwHTn%WIL*m{PDqAThsG46P44+<6#l=pB_=5 zDDQrVwYm2rwt+k@q;zFCGJ-Kvi9%LQdepBvb*%@Rz#Fw|9uyGXAy{@{+%JKxJ2?ri zm7&a~ErhM>LDXle(?6R#o=CMakl#|MPR4|;L`+PSR=(p^1v{~>A7z164~#TZpKf$u;zeF6`vwJ!l0yvq&;01_hYx{ROf1B=~`bP?!kxkFpdxDy>3(+h zih!3CeUG`F5BMm(5T<4zb-r2Sh>|vI(X&y#ax8q_+7S%HY2_qLtQqS#{%VLC9&hP{ zSgT_+)==5_2V$fHwz|GUSeD?NbKjY@8gV9;jOCt?(cKC&+hVO=Et2okgv-nt3G-THBmSMxZ{H@9&kCYnA=#%^e@E;4`OKh@(2eB( zmF5V4+#N)pbA+L$bAudkG-Njzcao|jcm=Sj*&iV5BE8ybj@ByaBA~4mSj3OL^gQCR zEP_%fN1m zuW)Z*J;J;XbVY3z9;DM#80oj2*R1*!KRxA12?k76&vp(T+AE-_{<+xx-~HG^_bU)Y z8RX{n-dH~OtZrZDRg6&p#;IwDzbCoR;wYLkNNi?AQz(XG9n^&w)jAi+<+E;Susvhu zb1Vw|3#G2MYGl*7`7y7bzu>kzAsv^ix)r}GZ-czT4T^go&*n|6iEnVF2hwBew2$jl zV9Txm!f99MCJu=+9(j9!KzOXQVU{V)pZV5*eM3|}c~Lp!IyYOezOu%L1>;*|OMuO< z%w*Hg>=-|!>7Xn=6hBSAKhF=K5|BeqAgrh1UmY99L5)-k#-_+ zJE)|$=cC_2N32YmdzwzKQPU64n-LKgJQ|pbgF}c34lZg4H8EupQ0&zFVPI}j<4qSw zTv33$dqyE+Y~Ta~mUP{?8>~lyNmAcTXlLVMD9peN)OD%feRm z7<9nUabKvlN8zl6C^|WPhbKYIdR4^d)QN28Z9KAz}%k)%;_VG@Ps@aN( zQiu>Wms6{|V|k4f6c&p9W41m>q@-uA7`*fqEA6*$zW~cGW{yh%#>e?qmMhiK71?zo zKoJh~%S*?dv!)4&^^`Vx{M6f?D)B?D-LyJ*LBgz|+?)*IY@{8URH*d1M*jw2( zD|eM8ah?2{`ix{R#Hk75_N^8T_(0dnukiF8Ewur|BaFQ<4wnY|4ifOENlc&9_B}Sq zx#Pfn@krKR=x7%0=G^*^{jtZbg|pq&phNQwx5mi1$l388+V)6$?2z*Wr}exQg|sR9nmVN+bBYP1p>~n{@T``!6etZ{Ac_qcRmuheR1Yto6m6 z#rVVEJMDL4f&j!OmM^D^-QaJqRB{~z8*5H%wfg0T-GT4bkjJ*JWLlKDu}8F%I+KP> zL}GkTUPrKAm&+0Pn1w=0gD;Lpe-kK0@51znYTILyp18tuigQ#1ZnUAB=A(_Xi=u_E zDE37GMZlDTH4UB1!%TKR&ruqc4L5KM04%) z6h%D7(Ik5~j~)wr=NiAN8Qk>Z8|7B-XHt7|3q|AH8J=;RG|3u^@7`*-jEOgT>ucwL zv_aOFF4G4_!+oHxKF$ww8oZX52A`#QpOjK{I3IK9>fCK5ooy*M{!-dNewS7394c;= z78!b~K1UH2<67XSt~*fQP|xz_T1ueHpV|r}EG|ltexEQvRj4>@)W6c+7wZ1=-Q}rX zv`xtLa9d0G2)<9-LAh}G;6aqba?}|m=G$K_PsPeCZ>A3}!9#&-WSIrDVb4yN)Vv&H#$e9@twIkyAS#R(uF$zxTnATnc4y zjatPQ)&F2U-=_5qp%5RN+II%U$bcQtj#U1x zqq~)qf_h)nUJe*YuQ{5AsgEE9>OgV5d5GVOO((4D>dj>HO#Uk&wkWwTB}0nW&*!YcrF?0LRBeR^@~qZMTZJ`jwK zCGSN6yE70!NQRQ&d!jw0an{RcFTwE|5TZZeM>r$AA3EY)+m_UYwIfa!#G2ayitP)Z z`zT@TCNIdoXmU+BfS78b99n~Ny>l9+2U`n$krH{|_fo{ww+D_dJx)wJj%4R1KLe*V zRHQI%XD$H-;Q`G}&FFRg^)h+k=7UL9(};X;6VN!JJSyzUvdfsBUW7t2nzY^@3K?6A zge>&nPL=QY;b$7RZ&eMz1TMJ_GZ|5w<2ocB{p42@Zq?~qH@wiXgnX~0HLpKE#Gjt# z2gG}IVwbmh0(56TSv_H!A!~P*>34DRm}OF@*{6qALx?aj;qhHcFY=Xu#WHmG^6HR} zb2VWt9T?>Zo|AVfx4Xmd{j}5fHS?xh$Lj7_et$Tk{)URE(*?UB#21NOtoB;&U)(Gc z;7Uo(s=3tcoZ_-ZM#G2~S@d-ifd>^Zil{92nsUuC&0W6pX||`vL>luZ|Ns9}q2<2{ z(*FN>`Fr9&nU(&3OjkO!rkgKJRTk_lcS-rSS7{<35|>%mTSPdzYXUz0>g;Ium!XOq+&pm04frF1bHdjj}zN&PN;}j>zM!4S_{YyBwP=xX4T$ zU$I831<11TdV)rXyy=N{>CwGUmo*DoUn7@ zT1Ss2!KVcE0Jgf*;Z4eX*`Ge~*}PT7$1lr9Z+E%1<_D1~7+<~Ok`meBk@j}bbW7Z5 zL&p{4t_E4kjyEIlkU$%D3zN3-8h^Ry2Vkb`e5G$KhnrF&5EM8+dy=tyrq`Q1_M^oQ(g;TX92mDg-$3deS~0AU zV{blU+6bm_f{v*l%g#0i4xp20iwauh3WXxwy<198WDEvT8wf?|)pw9DbkNf6dp%jhT7+8w#+cH*aXg-YQl_@v|UB?IP&r`%t{0@m4o z+PTK60`kMZJS{LhT(vvoyZ5pngFK(!{=(Y5(Y$m;g{%ulLQC6m(&2zEt z@h@J>9>z-$r4SQ<{89EAwLeJIJi4mB^bMHI(XI?aD3mmQLeHCY5S6xB>1^HNIO)ff z08Nh!z2dNQjIjX-FE0+#`xMED*s85tKO|*(oG;4LG7LAi$JYG?q=TF z=DeOOTR7df&PVS;(`GZWloNqmo|k-5DY?v-Qm8(RFXpJCxNi5hYNDKX@>xt1w>g)c zByj!_PH}Zn%=J=&SNWmt(YHQiNzhNblZ~bt zmG@|s8#Ov0wTm3XdjB-rC2$yL@D-yMrZRpPP(4q-|1)&X|Il{|R4{H~AxaT2&PoF5 z)GrtP9i3qVcB^ti`Fue!6W7*erjsV=ytUmOsKaMUn7)|_UvRyQq{m7KM@X_A#(g2T z@%#z4$SbfBpF1sg0zaV&-mq_fNgAe zqS5_*kFa?K(}2K74fi$du!6lN^oRd?_pxRE!JIISY$mTMAvFHDBCZ1K9sZ7*8b+LR!xp_20dHYaU)&?1 zZO(_lHmEAZv%TxbhQEztEu?q1HqtkjA8+%~Y3FE*$1r$Ec;ce2_Ryhr8A-_PFGS5# z*IOqPo+t`NAAPJcdel(yL|Lt|Li_}rm3=rXbq# zJ+_Ez;t!3zRjw`r#gqkj4cV}UD%($lrkT2GM9rJf38lu{FG`K+_osgUEU?2TZ!YT| zV?&qk5yK%mLHe_4(5@Xt0*FgzL9ChUow`bzd>)8+gS(|HO9)xFT+skNTA7lpa=+aP z?{(+*7eX~MPQ*vfUL7&1($B`q1#GVaqQBpksFci>88AA&&ZDf8e_H;_@^1G+>uStB z?>o`QEO~!Ug>*DaSn^U$6JJ1juL;BmTMn|Qnjd$Bn#iwP8r?@ZwMTE|mU5V=SfZ|E zFHqCmDfG-dPu;NPL@8&$^(wWXJr=eE;I+0&pbO4DVndcIof7r5WY&4aFR{FNd?AL~ zqNKUgRW3nd-|yok_(ZO-T;nI1KE#(LAa0SyJ+?&%ie<~{b@@?fd2J_VqIm)58mYM-3?O{5Ksl(m-hOjP@^ECGq)cUpk5l@RHBQ z@h-`sr^E}Yw+vekqs?9W27r{&Kw`-U=Ae{P)Eg@Ntm}*%9hRRsnZZ-?BCf>OzeeJ5 zns8EjEa}T=^oIZ&qKK&?niTfFe)L>5Iij_dg}cY@fyG19n_fHfZZX%HY$a}a;g&?g zJACE3M~&DB*cl4-bP0&t088AV=W}m(obsK8xIsv^n3+eL7i9R#$ zs=8n~c53GA!Whf3<<(3qFj|^k)sBitEPL{}iKwLGV+zR`%8J74eYm%MB!4AMtcFl84!fwBh+`mFpAfqoJ4v z@DN5CNO8+1f;$78dlq+Le}5AoxH=%$C{dPE;yflW@b;e!#JVn2$|r6?IevXSLKagR zOe4OX4$z5SB*$vuk1Yq9E5>fM8f78zn8+V3v4(Y5ov_jYE3!#J$7~_XBiV2;*A;@# zOmSs$DJ{CBsttP&*-yFjmpp)?5Dyvpp3swd$2CezIA*2dcMtORa220i?8fp=-rZSk zM6S;;pfUlVkeTTE)pxv3GqylkvwsH_>nVgDeLu;tp9M9PW?rMvzavd2<^NPE|NkVg z@IKh($Gf55q0zn|$eR7;b*I3dN>e=Y=agzSzUpsR`dg_^{@DeAaXk4;_dg%K03>*( Zb //与DCO签署邮箱保持一致 + 例如：Signed-off-by: user.name //与DCO签署邮箱保持一致 ![输入图片说明](https://images.gitee.com/uploads/images/2021/0625/095714_92d8e459_7756659.png "屏幕截图.png") -- GitLab